API ReferenceEvent Subscriptions

Get subscription

Returns one subscription without its signing secret. The Public API returns the secret only when the subscription is created.

Authentication

Authorizationstring

Use the API key format: api-key <token>.

Path parameters

subscriptionIdstringRequired
Subscription identifier returned by Create subscription.

Response headers

Cache-ControlstringOptional
Prevents storage of webhook configuration, payload, and diagnostic responses.

Response

The subscription. The signing secret is never included.
idstring
Subscription identifier.
statusenum

active subscriptions receive deliveries; paused ones do not.

endpointUrlstring
HTTPS URL events are delivered to.
eventTypeslist of enums
Event types this subscription receives.
createdAtdatetime
UTC timestamp when the subscription was created.
updatedAtdatetime
UTC timestamp of the last subscription change.
namestringOptional

Optional human-readable name. Omitted for subscriptions created before names were introduced.

filtersobjectOptional
Delivery filters. Omitted when none are configured.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
405
Method Not Allowed Error
406
Not Acceptable Error
429
Too Many Requests Error
500
Internal Server Error