API ReferenceEventsSubscriptions

Get subscription details

This endpoint returns details of a specific subscription.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

idstringRequiredformat: "uuid"

Response

Successfully retrieved subscription
idstringOptionalformat: "uuid"
Unique ID of the subscription
namestringOptional
Unique name of the subscription
endpointUrlstringOptional
Target URL for the webhook delivery
secretRefstringOptional
Reference name of the secret used for signing
eventTypeslist of stringsOptional
List of event types subscribed to. If null or empty, all event types are received.
isActivebooleanOptional
Whether the subscription is active
descriptionstringOptional
Optional description
createdTimestringOptionalformat: "date-time"
Time when the subscription was created
updatedTimestringOptionalformat: "date-time"
Time when the subscription was last updated
createdBystringOptional
Username of the user who created the subscription
updatedBystringOptional
Username of the user who last updated the subscription
secretValuestring or nullOptional

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