Skip to navigation
NotificationsWebhook Subscriptions

Create Webhook Subscription

Create a new webhook subscription.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
urlstringRequiredformat: "uri"1-2083 characters
The target URL of the webhook
event_nameenumRequired
The event name that triggers the webhook
filtersobject or nullOptional
Webhook filters
secretstring or nullOptional
The secret used to sign messages

Response

Successful Response
Webhookobject
Webhook model
OR
list of objects

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
405
Method Not Allowed Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error