Creates a new webhook.

POST

Creates a new webhook. The receiver type is inferred from the URI. All unknown receivers are treated as ‘custom’.

Required Permissions: The user must be an admin or have workspace-manage-config:write permissions.

Request

This endpoint expects an object.
namestringRequired>=1 character

The name of this webhook event.

uristringRequired>=1 character

The URI to call.

eventsstringRequired>=1 character

The event(s) that trigger the web hook. A comma-separated list of events that trigger the webhook. The allowed events depend on the webhook type. For type ‘custom’: retrieve the list of allowed events from ‘/webhooks/eventTypes’ For type ‘slack’: retrieve the list of allowed events from ‘/webhooks/eventTypes/slack’

isActivebooleanRequired

Whether the web hook is currently active.

authenticationTypestringRequired>=1 character

The authentication type to use when calling the URI. Can be ‘none’, ‘header’.

languagestringOptional

The language of the web hook message that will be sent to the receiver. Not required for custom web hooks.

authenticationstringOptional

The authentication value to use when calling the URI. Should be ‘key=value’. In case of header authentication, this should be ‘headername=headervalue’. Only required when the AuthenticationType is anything other than ‘none’.

Response

OK

namestring>=1 character

The name of this webhook event.

uristring>=1 character

The URI to call.

eventsstring>=1 character

The event(s) that trigger the web hook. A comma-separated list of events that trigger the webhook. The allowed events depend on the webhook type. For type ‘custom’: retrieve the list of allowed events from ‘/webhooks/eventTypes’ For type ‘slack’: retrieve the list of allowed events from ‘/webhooks/eventTypes/slack’

isActiveboolean

Whether the web hook is currently active.

authenticationTypestring>=1 character

The authentication type to use when calling the URI. Can be ‘none’, ‘header’.

languagestringOptional

The language of the web hook message that will be sent to the receiver. Not required for custom web hooks.

authenticationstringOptional

The authentication value to use when calling the URI. Should be ‘key=value’. In case of header authentication, this should be ‘headername=headervalue’. Only required when the AuthenticationType is anything other than ‘none’.

idstringOptional

The id of the webhook config.

receiverTypestringOptional

The type of the web hook. Can be ‘custom’, ‘slack’.

lastFailureReasonstringOptional

The most recent failure reason.

createdOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The date this webhook config was created.

createdBystringOptional

The id of the user who created this webhook config.

updatedOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The date this webhook config was last modified.

updatedBystringOptional

The id of the user who last modified this webhook config.