Webhook events

XQUARE sends events to the endpoints you add on the Connections page of the vendor panel, or with /v1/webhook-endpoints. Each endpoint receives only the events you pick for it. To check that a delivery really came from XQUARE, see Receive and verify webhooks.

Envelope

Every event has the same outer shape:

{
  "id": "evt_…",
  "type": "voucher.redeemed",
  "api_version": "2026-10-08",
  "created_at": "2026-10-20T09:12:44.000Z",
  "space_id": "…",
  "data": { }
}

Field	Meaning
id	Unique per event and the same on every retry. Use it to deduplicate.
type	One of the events below. The X-XQ-Event header has the same value.
api_version	The payload version of this event type. A breaking change ships under a new version.
created_at	When the event happened: UTC, ISO 8601 with milliseconds
space_id	Your Space
data	The event's details

Payloads carry no customer personal data. XQUARE refuses to send an event whose data holds customer contact details.

Events

Event	When
voucher.issued	A voucher was issued
voucher.redeemed	A voucher was redeemed
voucher.exhausted	A voucher reached its redemption limit
voucher.expired	A voucher passed its end date (sent by a nightly run)
voucher.voided	A voucher was voided
sponsor.package.purchased	A sponsor package was purchased
sponsor.package.expired	A sponsor package ended
sponsor.redemption.created	A perk from a sponsor package was redeemed
event.ticket.checked_in	A ticket was checked in
api_key.revoked	One of your API keys was revoked
credits.balance_low	Your credit balance fell below its alert threshold
credits.daily_summary	Your credit usage for the previous day (sent by a nightly run)
webhook.test	A test ping sent from the Connections page. You do not subscribe to it

v1 — expanding

The fields inside data for each event are not listed here yet. Read the fields you need defensively, and ignore fields you do not know: new fields can be added without a new api_version.

Not yet available

• A customer reference in voucher events. A pseudonymous customer_ref is under legal review and is not sent today.