Sign in
Webhook API:Webhooks

Add a new webhook

post/webhooks

Request body

namestring nullable required
eventsEventName[] nullable required
urlstring uri nullable required

Target URL that will listen for incoming HTTP POST notification messages.

authorizationstring nullable

Optional authorization header to include with the HTTP POST notification.

status'Enabled' | 'Disabled' | 'Suspended' string

Example request

{
  "authorization": "Basic dXNlcm5hbWU6cGFzc3dvcmQ="
}

Response

Created

webhookIdstring uuid
namestring nullable
status'Enabled' | 'Disabled' | 'Suspended' | 'Failed' string
urlstring uri nullable
eventsEventName[] nullable
createdAtstring date-time
updatedAtstring date-time
enabledAtstring date-time nullable
disabledAtstring date-time nullable
suspendedAtstring date-time nullable
failedAtstring date-time nullable

Changes