Sign in

v2

latestOpenAPI 3.0.3Apache 2.02026-08-0715707.5 MB
Webhook Subscriptions

Create a webhook subscription

Creates a webhook subscription.

post/webhooks

Request body

titlestring required

Title of the webhook for use on tenant side.

urlstring url required

The callback URL to be called by the webhook.

typestring[]

What kind of events to be sent by the webhook.

exclude_typestring[]

What kind of events to be excluded if subscription type is: ALL.

Response

Returns a webhook subscription object if a valid webhook subscription object ID was provided.

idstring uuid required

Webhook unique identifier.

created_atstring date-time required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

updated_atstring date-time required

Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC

titlestring required

Title of the webhook for use on tenant side.

urlstring url required

The callback URL to be called by the webhook.

enabledboolean required

Enable/disable webhook.

typestring[] required

What kind of events to be sent by the webhook.

exclude_typestring[]

What kind of events to be excluded if subscription type is: ALL.