Skip to content
Developer preview: the API may change before general availability. Request access

Event types

All events share the same envelope (see Webhooks). You only receive events for locations and scopes the merchant granted you.

Event When Scope
order.created A new order arrived from any channel. data is the full order. orders:read
order.status_changed An order moved to a new status orders:read
order.updated Items, notes or totals changed. Fetch the order again. orders:read
order.cancelled The channel, merchant or customer cancelled the order orders:read
connection.created A merchant connected to your application —
connection.updated The merchant changed scopes or locations —
connection.revoked The merchant withdrew access —
location.updated A location’s name, status or address changed locations:read
channel_connection.status_changed A location’s channel connection changed status, e.g. needs reconnecting locations:read
Event When
catalog.updated A location’s menu changed
order.delivery_status_changed Delivery progress for an order
order.handler_timeout An order wasn’t accepted in time
sync_job.completed / sync_job.partially_failed / sync_job.failed Result of a menu, availability or hours update
{
"id": "evt_01J9C2W8QD",
"type": "order.created",
"created_at": "2026-10-04T12:01:06Z",
"merchant_id": "mer_7Hq2Lw8Z",
"location_id": "loc_2Xf9K",
"connection_id": "con_4Tz8Yp1W",
"origin": { "type": "channel", "application_id": null },
"data": {
"id": "ord_01J9QW3T8M",
"version": 1,
"channel_ref": "CH-88213",
"status": "placed",
"items": [ … ],
"totals": { "total": { "amount": 7475, "currency": "SAR" } }
}
}