Get subscription

Returns one subscription. The signing secret is write-only and never returned.

Authentication

Authorizationstring

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

Path parameters

subscriptionIdstringRequired
Subscription identifier returned by Create subscription.

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.
filtersobject
Delivery filters. Omitted when none are configured.
createdAtdatetime
UTC timestamp when the subscription was created.
updatedAtdatetime
UTC timestamp of the last subscription change.

Errors

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