API v1 ReferenceWebhooks

Creates a new webhook.

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.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

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'.
languagestring or nullOptional
The language of the web hook message that will be sent to the receiver. Not required for custom web hooks.
onlyTriggerForMainEntityChangesbooleanOptional
Whether to only send events for main entity changes and not for nested entities if the webhook is for a model.
authenticationstring or nullOptional

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'.
languagestring or null
The language of the web hook message that will be sent to the receiver. Not required for custom web hooks.
onlyTriggerForMainEntityChangesboolean or null
Whether to only send events for main entity changes and not for nested entities if the webhook is for a model.
authenticationstring or null

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’.

idUUID or null
The id of the webhook config.
receiverTypestring or null
The type of the web hook. Can be 'custom', 'slack'.
lastFailureReasonstring or null
The most recent failure reason.
createdOndatetime or null
The date this webhook config was created.
createdByUUID or null
The id of the user who created this webhook config.
updatedOndatetime or null
The date this webhook config was last modified.
updatedByUUID or null
The id of the user who last modified this webhook config.