Webhooks

Create and inspect webhook subscriptions and event payload examples.

Webhook subscriptions send a POST request to the configured URL when an event occurs. The Webhook collection lets an API key retrieve subscriptions and create one subscription per event type. Update, delete, and delivery-log operations are available for individual subscriptions.

Supported events

The maintained API Blueprint lists these event names: TicketCreated, TicketActivated, TicketUpdated, TicketForwarded, TicketCancelled, TicketReleased, SeasonCardCreated, SeasonCardActivated, SeasonCardUpdated, SeasonCardForwarded, SeasonCardReleased, SeasonCardCancelled, OrderCreated, OrderPaid, OrderCancelled, OrderLineCancelled, CustomerCreated, CustomerUpdated, CustomerDeleted, ConsentGranted, ConsentRetracted, PassEntered, and PartnerRegistration.

Payload examples

GET /webhooks/event/{EventName} retrieves a camel-case preview payload for a supported event. It is an API-reference example, not the JSON contract sent to your subscription URL.

Webhook delivery is a POST to the configured URL. Delivery JSON uses PascalCase: EventName, IdempotencyKey, CreatedAtUtc, and Data. The idempotency key is a 32-character GUID without hyphens. Most event data includes the integration metadata Id, CreationDate, TenantId, and OrganiserId; the envelope timestamp is the event creation date. TicketForwarded only contains TicketId and Recipient, and TicketReleased only contains TicketId; their timestamps are assigned when published.

{
  "EventName": "TicketReleased",
  "IdempotencyKey": "a1b2c3d4e5f67890abcdef1234567890",
  "CreatedAtUtc": "2026-09-17T10:00:00Z",
  "Data": {
    "TicketId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

Historical concrete event examples from the supplied workspace export are retained in the authenticated API Blueprint archive. They supplement the generic maintained endpoint and do not define additional canonical API paths.