webhooks

Creates a new webhook.

Changed on

The receiver type is inferred from the URI. All unknown receivers are treated as 'custom'.

<Check title="Required Permissions" icon="key">The user must be an admin or have workspace-manage-config:write permissions.</Check>

post/webhooks

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/webhooks
  • Auth: HTTP bearer

Request body

namestring required

The name of this webhook event.

uristring required

The URI to call.

languagestring nullable

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

eventsstring required

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 required

Whether the web hook is currently active.

onlyTriggerForMainEntityChangesboolean

Whether to only send events for main entity changes and not for nested entities if the webhook is for a model.

authenticationTypestring required

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

authenticationstring nullable

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 required

The name of this webhook event.

uristring required

The URI to call.

languagestring nullable

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

eventsstring required

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 required

Whether the web hook is currently active.

onlyTriggerForMainEntityChangesboolean

Whether to only send events for main entity changes and not for nested entities if the webhook is for a model.

authenticationTypestring required

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

authenticationstring nullable

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

idstring uuid

The id of the webhook config.

receiverTypestring nullable

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

lastFailureReasonstring nullable

The most recent failure reason.

createdOnstring date-time

The date this webhook config was created.

createdBystring uuid

The id of the user who created this webhook config.

updatedOnstring date-time

The date this webhook config was last modified.

updatedBystring uuid

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

Changes