WebhookSubscription

Type: WebhookSubscription

WebhookSubscription has 8 top-level fields. Fields typed as another schema link to that schema's page, and nested objects expand in place below. It is referenced by 5 operations, listed under Used by. The machine-readable definition is #/components/schemas/WebhookSubscription in openapi.json; the example in the right-hand rail is synthesized from the field examples in that spec.

Fields

id integer
object string
url string
event_filter array of WebhookEventName Empty = subscribed to ALL events.
active boolean
last_delivered_at string (date-time), nullable
created_at string (date-time)
updated_at string (date-time)

Used by

GET /webhook_subscriptions List webhook subscriptions
POST /webhook_subscriptions Create a webhook subscription
GET /webhook_subscriptions/{id} Show a webhook subscription
PATCH /webhook_subscriptions/{id} Update a webhook subscription
POST /webhook_subscriptions/{id}/rotate_secret Rotate the signing secret