API ReferenceEvent Deliveries

Get subscription details

This endpoint returns details of a specific subscription.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequiredformat: "uuid"

Response

Successfully retrieved subscription
idstringformat: "uuid"
Unique ID of the subscription
namestring
Unique name of the subscription
endpointUrlstring
Target URL for the webhook delivery
secretRefstring
Reference name of the secret used for signing
eventTypeslist of strings
List of event types subscribed to. If null or empty, all event types are received.
isActiveboolean
Whether the subscription is active
descriptionstring
Optional description
createdTimestringformat: "date-time"
Time when the subscription was created
updatedTimestringformat: "date-time"
Time when the subscription was last updated
createdBystring
Username of the user who created the subscription
updatedBystring
Username of the user who last updated the subscription
secretValuestring or null

Plaintext secret value, populated only on create when the secret was auto-generated. Returned once.

Errors

401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
5XX
Server Error