Skip Navigation Links

Webhooks

List webhooks of the userexperimental

Requires authentication via bearer.

Lists all webhooks that were registered for the current user and their status. The current actor needs the legacy permission WEBHOOK_MANAGEMENT.

Query Params

show_authentication boolean

Toggle showing webhook authentication info on response.

Response Body

200 OK

Registers new webhookexperimental

Requires authentication via bearer.

Adds a new webhook to the tenant's webhook registry. The webhook will immediately start to receive user-visible events of the specified type as they occur. The current actor needs the legacy permission WEBHOOK_MANAGEMENT.

Request Body

subscription objectrequired

Describes the types of events the webhook is subscribed to.

url stringrequired

The callback URL of this webhook. Events this webhook is subscribed to will be delivered to this URL. Only accepted protocol is HTTPS.

Response Body

201 Created

Error Codes

  • INVALID_SUBSCRIPTION
  • INVALID_URL
  • INVALID_URL_IS_NOT_USING_HTTPS
  • TOO_MANY_WEBHOOKS_REGISTERED
  • DUPLICATE_URL

Get the specified webhookexperimental

Requires authentication via bearer.

Returns the webhook with the specified id, provided that it exists and the user is allowed to see it. The current actor needs the legacy permission WEBHOOK_MANAGEMENT.

Path Params

webhook_id stringrequired

The unique identifier of a Webhook.

Query Params

show_authentication boolean

Toggle showing webhook authentication info on response.

Response Body

200 OK

Deletes the specified webhookexperimental

Requires authentication via bearer.

Removes the specified webhook from the webhook registry. No more events will be delivered to this webhook and any queued events will be lost. The current actor needs the legacy permission WEBHOOK_MANAGEMENT.

Path Params

webhook_id stringrequired

The unique identifier of a Webhook.

Response Body

200 OK

Pause the specified webhookexperimental

Requires authentication via bearer.

Pauses the specified webhook. A PAUSED webhook is not delivering events until reactivated, but events are buffered. The current actor needs the legacy permission WEBHOOK_MANAGEMENT.

Path Params

webhook_id stringrequired

The unique identifier of a Webhook.

Response Body

200 OK

Unpauses the specified paused webhookexperimental

Requires authentication via bearer.

Webhook is reactivated and will resume delivery of events. The current actor needs the legacy permission WEBHOOK_MANAGEMENT.

Path Params

webhook_id stringrequired

The unique identifier of a Webhook.

Query Params

show_authentication boolean

Toggle showing webhook authentication info on response.

Response Body

200 OK
429 Too Many Requests

Error Codes

  • WEBHOOK_NOT_FOUND