API ReferenceWebhooks

Fetch Webhook Subscription

Fetch a webhook subscription

Required OAuth 2.0 scope: application/webhooks:read

Path parameters

subscription_idstringRequired>=1 character<=100 characters
The unique identifier of the subscription.

Headers

AuthorizationstringRequired

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

Response

Successful Response
created_atstringformat: "date-time"
The subscription creation date and time in ISO 8601 format.
enabledboolean
A flag indicating whether the subscription is enabled.
event_typeslist of enums
A list of event types the subscription is bound to.
Allowed values:
idstring
The unique identifier of the subscription.
namestring
A friendly name to describe the subscription.
notification_urlstring
The URL to be notified when an event occurs.
secretstring or null
The secret used to verify the payload of a webhook, only available upon creation.
updated_atstringformat: "date-time"
The date and time the subscription was last modified in ISO 8601 format.

Errors