Subscribe to purchase events

View as Markdown

Authentication

AuthorizationBearer

Production machine-to-machine flow. Tokens issued by Descope.

Request

This endpoint expects an object.
urlstringRequiredformat: "uri"
HTTPS endpoint where Andel will POST events.
event_typeslist of enumsRequired
descriptionstringOptional

Human-readable label for this subscription.

Response

Subscription created. The response includes the signing secret used to verify webhook payloads.
subscription_idstringformat: "uuid"
urlstringformat: "uri"
event_typeslist of strings
created_atdatetime
signing_secretstring

Secret used to verify the X-Andel-Signature header on webhook deliveries. Returned once at creation.

descriptionstring

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error