WebhookSubscriptionWithSecret

Type: WebhookSubscription

WebhookSubscriptionWithSecret has 9 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 2 operations, listed under Used by. The machine-readable definition is #/components/schemas/WebhookSubscriptionWithSecret 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)
signing_secret string

Used by

POST /webhook_subscriptions Create a webhook subscription
POST /webhook_subscriptions/{id}/rotate_secret Rotate the signing secret