Payload Reference
Comprehensive reference for the JSON objects sent by OrderInWhats webhooks.
Root Object Fields
| Field | Type | Description |
|---|---|---|
| eventId | String | A unique identifier for this specific event notification. |
| event | String | The type of event (e.g., order.created). |
| restaurant | Object | Contains the ID and name of the store that triggered the event. |
| data.order | Object | The core order details, including products and user info. |
{
"eventId": "order.created:64f...:1769608953282",
"event": "order.created",
"occurredAt": "2026-01-28T14:02:33.282Z",
"restaurant": {
"id": "rest_68b52c6b25f6",
"name": "Restaurant Name"
},
"data": {
"order": {
"OrderId": "1001",
"userId": {
"phoneNumber": "94700000000",
"botPhoneNumber": "94711111111",
"role": "customer",
"stripeCustomerId": "cus_ThPpbIzysMamRM"
},
"products": [
{
"orderName": "Beef Pepperoni",
"category": "Non-Veg",
"price": 15,
"currency": "USD",
"quantity": 1,
"isCustomizable": true,
"_id": "prod_697a16f80f"
}
],
"isConfirm": false,
"isPaid": false,
"_id": "ord_697a16f80f0c",
"createdAt": "2026-01-28T14:02:32.794Z"
}
}
}Note on order.deleted
The order.deleted event shares the same structure as order.status.changed. It is fired when an order record is purged from the database, usually following an expiration or manual cancellation.