Skip to main content
POST
List webhooks
Required scopes: webhooks.configuration:rw

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
owner_client_id
string
required

The webhook owner (the Client ID for which the webhook is registered).

Response

200 - application/json

A list of registered webhooks.

id
string

Unique ID of the webhook.

url
string

The destination URL for the webhook.

description
string

The webhook description.

action
string

The action that triggers sending the webhook.

secret_key
string

The secret key sent in webhooks to verify the source.

additional_data
string[]

Additional data arriving with the webhook.

filters
object

The filters to check if a webhook should be triggered.

owner_client_id
string

The Client ID that owns the webhook.

type
enum<string>

The webhook type.

Available options:
bot,
license