order.placed webhook
The order.placed webhook: a diner's dine-in or pickup order from your app reached the restaurant's team, with ids, lines and amounts.
A diner sent their order to the restaurant's team from your app: dine-in at the table they scanned, or a pickup. This is the restaurant's choice of orders go to Tamr. Sent once per order: the webhook-id is fixed by the order, so a retried send that returns the same order sends nothing new. An order sent from Tamr's own QR menu sends none.
A pickup paid at the counter is sent when the diner places it. One paid ahead with Tamr Pay is sent only once the payment is confirmed and the order reaches the team; one that expires unpaid sends none.
Test orders. A test key's pickup is checked and priced as a real one but written nowhere: your test endpoints get this event with livemode: false, test: true and an orderId that starts test_. See Test orders.
Ids and amounts only: never a dish's name, a note, a name or a phone. A pickup's name, phone and car stay with the restaurant. status is sent when it goes out; read a value you don't know as unknown.
The data object
| Field | Type | Description |
|---|---|---|
externalUserId | string or null | 1 to 200 characters. |
conversationId | string or null | 1 to 200 characters. |
orderId | string | 1 to 200 characters. |
number | integer | The short number staff call out, per branch and service day. -9,007,199,254,740,991 to 9,007,199,254,740,991. |
status | string | One of awaiting_payment, sent, accepted, served, declined, cancelled, expired, unknown. An open list: read a value you don't know as unknown. |
branch | string | An address: lower-case letters, digits and dashes. |
table | string or null | 1 to 40 characters. |
currency | string | A three-letter currency code (ISO 4217). |
subtotal | string | An amount in minor units, as a string. |
lines | array of object | 1 to 100 items. |
lines[].dishId | string or null | 1 to 200 characters. |
lines[].externalId | string or null | 1 to 200 characters. |
lines[].quantity | integer | -9,007,199,254,740,991 to 9,007,199,254,740,991. |
lines[].unitPrice | string | An amount in minor units, as a string. |
fulfilment | string | May be absent. One of dine_in, pickup, unknown. An open list: read a value you don't know as unknown. |
pickupAt | string (date-time) or null | May be absent. |
pickupCode | string or null | May be absent. 1 to 12 characters. |
test | boolean | May be absent. |
Examples
{
"type": "order.placed",
"timestamp": "2026-11-04T19:42:00.000Z",
"livemode": true,
"data": {
"externalUserId": "user-88213",
"conversationId": "conv_01",
"orderId": "ord_01",
"number": 17,
"status": "sent",
"branch": "achrafieh",
"table": "12",
"currency": "USD",
"subtotal": "2450",
"lines": [
{
"dishId": "dish_kafta",
"externalId": "SKU-KAFTA",
"quantity": 2,
"unitPrice": "900"
},
{
"dishId": "dish_fattoush",
"externalId": null,
"quantity": 1,
"unitPrice": "650"
}
]
}
}A guest with no conversation, and a status this client doesn't know yet: it reads as unknown.
{
"type": "order.placed",
"timestamp": "2026-11-04T19:50:00.000Z",
"livemode": true,
"data": {
"externalUserId": null,
"conversationId": null,
"orderId": "ord_02",
"number": 18,
"status": "on_hold",
"branch": "achrafieh",
"table": "4",
"currency": "LBP",
"subtotal": "1500000",
"lines": [
{
"dishId": "dish_kafta",
"externalId": null,
"quantity": 1,
"unitPrice": "1500000"
}
]
}
}A pickup paid ahead (#599), sent once it was paid: its time and code, never the name or phone.
{
"type": "order.placed",
"timestamp": "2026-11-04T19:42:00.000Z",
"livemode": true,
"data": {
"externalUserId": "user-88213",
"conversationId": "conv_01",
"orderId": "ord_0600",
"number": 24,
"status": "sent",
"branch": "achrafieh",
"table": null,
"currency": "USD",
"subtotal": "2450",
"lines": [
{
"dishId": "dish_kafta",
"externalId": "SKU-KAFTA",
"quantity": 2,
"unitPrice": "900"
},
{
"dishId": "dish_fattoush",
"externalId": null,
"quantity": 1,
"unitPrice": "650"
}
],
"fulfilment": "pickup",
"pickupAt": "2026-11-09T07:00:00.000Z",
"pickupCode": "5310"
}
}A test event
What Send a test event in the dashboard sends: livemode: false, and every id starting test_.
{
"type": "order.placed",
"timestamp": "2026-11-16T12:00:00.000Z",
"livemode": false,
"data": {
"externalUserId": "test_user",
"conversationId": "test_conversation",
"orderId": "test_order",
"number": 1,
"status": "sent",
"branch": "test-branch",
"table": "1",
"currency": "USD",
"subtotal": "1800",
"lines": [
{
"dishId": "test_dish",
"externalId": null,
"quantity": 2,
"unitPrice": "900"
}
]
}
}