{"info":{"_postman_id":"4b74b1f5-b5a6-4f9c-88ae-4a9acb9ca073","name":"Eat Webhooks","description":"

EatApp utilizes webhooks to notify external systems about real-time events related to Guests and Reservations. Whenever specific actions occur, such as creating, updating, or canceling a guest profile or reservation, EatApp sends an Http request containing relevant event data to your configured webhook endpoint. This allows seamless integration with your system, enabling you to automate workflows, update records, or trigger specific actions based on these events.

Events payload are in JSONAPI format, which makes it easy for our partners to integrate our APIs and Webhooks with the same exact format.

Every event includes meta section that includes the following data:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Details
`meta.created_at`	Timestamp when the event occurred, in Unix epoch format
`meta.number`	Sequential event number, can be used to follwo the order of events or for internal troubleshooting
`meta.event`	Type of event that triggered the webhook
`meta.initiator`	The user email who made the action
`meta.changes`	Changes that will happen to the object The first attribute of the key will represent the old state, and the second attribute will represent the new state. Example: meta.changes.status -> ['confirmed', 'seated'] Confirmed is the old stat,e and Seated is the new state

Eat App events are configured around 2 main objects, Guest and Reservation, in the webhook each object includes all data from the object relationships following the same format as JSONAPI.

List of Events:

Guest Events:

create_guest
\n
update_guest
\n
delete_guest
\n

Reservation Events:

create_reservation
\n
update_reservation
\n
delete_reservation
\n
place_web_reservation
\n
cancel_web_reservation
\n
update_web_reservation
\n
place_user_reservation
\n
cancel_user_reservation
\n
update_user_reservation
\n
place_partner_reservation
\n
update_partner_reservation
\n
cancel_partner_reservation
\n
place_concierge_reservation
\n
update_concierge_reservation
\n
cancel_concierge_reservation
\n

Notes:

Single event can fire multiple webhooks
example:
place_web_reservation indicates a reservation been created via the widget, that event will fire 2 webhooks, 1 guest creation , and another one for reservation creating, both webhooks will have the same event name and same sequential number, but the payload will be different.
\n
Reservation can be create without Guest information, usually indicates a walk-in reservation, later restaurant might decide to add a profile to the reservation or not. every update will fire webhook event.
\n
Delete Events are not active yet
\n

Changes Log:

22 October 2024

Include initiator in meta attributes
\n
Include custom_fields in Guest And Reservation Payloads
\n
Include restaurant in Guest and Reservation Relationships
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Changes Log:","slug":"changes-log"}],"owner":"6173104","collectionId":"4b74b1f5-b5a6-4f9c-88ae-4a9acb9ca073","publishedId":"2sA35EYhLT","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-03-27T11:13:36.000Z"},"item":[{"name":"Guest Payload","item":[],"id":"c8f7d54e-c6d2-44fe-b7ae-b489667f1f2e","description":"

Guest Events are expected to be pushed in the webhook anytime a guest profile is getting created or updated, that include any time an online reservation is created.

Example of Guest Payload:

{\n  \"meta\": {\n    \"created_at\": 1711442409.240197,\n    \"number\": 257865,\n    \"event\": \"update_guest\"\n  },\n  \"data\": {\n    \"id\": \"efe3d0c4-46c5-4ae2-840c-0a941f5a6305\",\n    \"type\": \"guest\",\n    \"attributes\": {\n      \"restaurant_id\": \"63c6a71c-9e6e-420e-b290-d8b1b64fb1e5\",\n      \"first_name\": \"Jason\",\n      \"last_name\": \"Gamble\",\n      \"phone\": \"+971505000000\",\n      \"email\": \"jason@mailinator.com\",\n      \"alt_email\": null,\n      \"alt_phone\": null,\n      \"notes\": \"Note...\",\n      \"birthday\": null,\n      \"anniversary\": null,\n      \"pos_data\": {\n        \"total_spend\": 0,\n        \"visit_count\": 0,\n        \"average_spend_per_cover\": 0,\n        \"average_spend_per_visit\": 0\n      },\n      \"visit_data\": {\n        \"last_visit\": \"2024-02-19T18:00:00\",\n        \"next_visit\": \"2024-03-26T16:15:00\",\n        \"first_visit\": \"2024-02-19T18:00:00\",\n        \"visit_count\": 1,\n        \"denied_count\": 0,\n        \"visit_covers\": 2,\n        \"denied_covers\": 0,\n        \"next_visit_id\": \"c4b43e13-2c2c-48ad-b1bc-c89446069d1a\",\n        \"no_show_count\": 0,\n        \"reviews_count\": 0,\n        \"canceled_count\": 0,\n        \"no_show_covers\": 0,\n        \"canceled_covers\": 0,\n        \"reviews_average_rating\": 0,\n        \"reviews_average_food_rating\": 0,\n        \"upcoming_reservations_count\": 3,\n        \"reviews_average_service_rating\": 0,\n        \"reviews_average_ambience_rating\": 0\n      },\n      \"profile_image_url\": null,\n      \"title\": null,\n      \"gender\": \"male\",\n      \"organisation\": \"Demo\",\n      \"job_title\": \"Dr\",\n      \"profession\": null,\n      \"address\": null,\n      \"loyalty_sid\": null,\n      \"visit_count\": 1,\n      \"cancellation_count\": 0,\n      \"no_show_count\": 0,\n      \"imported_reservation_count\": 0,\n      \"custom_fields\": {\n        \"custom_field_1\": \"custom_value_1\",\n        \"custom_field_2\": \"custom_value_2\"\n      },\n      \"shared_key\": \"75320ae1-151d-4869-96b2-360a60add4e2\",\n      \"created_at\": \"2024-02-19T19:43:06\",\n      \"updated_at\": \"2024-03-26T12:40:08\",\n      \"terms_and_conditions_accepted_at\": \"2024-02-19T19:43:06\",\n      \"marketing_accepted_at\": \"2024-02-19T19:43:06\"\n    },\n    \"relationships\": {\n      \"tags\": {\n        \"data\": [\n          {\n            \"id\": \"476b8b51-1070-4e6c-ae11-61070e275489\",\n            \"type\": \"tag\"\n          }\n        ]\n      },\n      \"restaurant\": {\n        \"data\": {\n          \"id\": \"63c6a71c-9e6e-420e-b290-d8b1b64fb1e5\",\n          \"type\": \"restaurant\"\n        }\n      }\n    }\n  },\n  \"included\": [\n    {\n      \"id\": \"476b8b51-1070-4e6c-ae11-61070e275489\",\n      \"type\": \"tag\",\n      \"attributes\": {\n        \"name\": \"High Spender\",\n        \"type\": \"Guest\",\n        \"restaurant_id\": \"63c6a71c-9e6e-420e-b290-d8b1b64fb1e5\",\n        \"created_at\": \"2020-10-14T11:43:05\",\n        \"updated_at\": \"2024-03-26T12:32:52\"\n      },\n      \"relationships\": {}\n    },\n    {\n      \"id\": \"63c6a71c-9e6e-420e-b290-d8b1b64fb1e5\",\n      \"type\": \"restaurant\",\n      \"attributes\": {\n        \"name\": \"Ali Cafe\",\n        \"difficult\": false\n      },\n      \"relationships\": {}\n    }\n  ]\n}\n\n

Guest Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Details
`data.id`	Guest primary ID
`data.type`	Type of resource being handled in the webhook
`restaurant_id`	Restaurant ID
`first_name`	Guest’s first name
`last_name`	Guest’s last name
`phone`	Guest’s primary phone number
`email`	Guest’s primary email address
`alt_email`	Guest’s alternative email address (if any)
`alt_phone`	Guest’s alternative phone number (if any)
`notes`	Additional notes about the guest
`birthday`	Guest’s birthday, if provided
`anniversary`	Guest’s anniversary date, if provided
`profile_image_url`	URL of the guest's profile image (if provided)
`title`	Guest’s title (e.g., Mr., Dr.)
`gender`	Guest’s gender
`organisation`	Name of the organization the guest is associated with
`job_title`	Job title of the guest
`profession`	Profession of the guest
`address`	Guest’s address
`loyalty_sid`	Loyalty system ID (if applicable)
`visit_count`	Total number of visits by the guest (overall)
`cancellation_count`	Total number of cancellations by the guest
`no_show_count`	Total number of no-shows by the guest
`imported_reservation_count`	Number of reservations imported for the guest from external system
`shared_key`	Guest unique identifier for guest across group level, other linked guest profile from another venue can have the same id if its the same guest
`custom_fields`	Guest Custom fields, in JSON format
`created_at`	Timestamp of when the guest profile was created
`updated_at`	Timestamp of when the guest profile was last updated
`terms_and_conditions_accepted_at`	Timestamp of when the guest accepted terms and conditions
`marketing_accepted_at`	Timestamp of when the guest accepted marketing communication
`pos_data.total_spend`	Total spending of the guest at the restaurant
`pos_data.visit_count`	Total number of visits by the guest
`pos_data.average_spend_per_cover`	Average spend per guest cover (individual seat)
`pos_data.average_spend_per_visit`	Average spend per visit by the guest
`visit_data.last_visit`	Timestamp of the guest’s last visit
`visit_data.next_visit`	Timestamp of the guest’s next visit
`visit_data.first_visit`	Timestamp of the guest’s first visit
`visit_data.next_visit_id`	Next Reservation ID
`visit_data.visit_count`	Total number of visits by the guest
`visit_data.denied_count`	Number of times the guest was denied a reservation
`visit_data.visit_covers`	Number of guests (covers) included in the guest's visits
`visit_data.denied_covers`	Number of guests (covers) denied with the guest
`visit_data.no_show_count`	Number of no-shows by the guest
`visit_data.reviews_count`	Number of reviews provided by the guest
`visit_data.canceled_count`	Number of canceled reservations by the guest
`visit_data.no_show_covers`	Number of guest covers in no-shows
`visit_data.canceled_covers`	Number of guest covers in canceled reservations
`visit_data.reviews_average_rating`	Average rating given by the guest across all reviews
`visit_data.reviews_average_food_rating`	Average food rating given by the guest
`visit_data.upcoming_reservations_count`	Number of upcoming reservations by the guest
`visit_data.reviews_average_service_rating`	Average service rating given by the guest
`visit_data.reviews_average_ambience_rating`	Average ambience rating given by the guest

Guest Relationships

Tags:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Details
`data.id`	Tag primary ID
`restaurant_id`	Restaurant ID
`name`	Tag Name
`type`	Tag type, can be `Guest` or `Reservation`
`created_at`	Timestamp of when the tag was created
`updated_at`	Timestamp of when the tag was last updated

Restaurant

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Details
`data.id`	Restaurant primary ID
`name`	Restaurant Name
`difficult`	Determine if restaurant needs to manually confirm reservations - `true`: restaurant manually confirm reservations - `flase`: reservations are auto confirmed

","_postman_id":"c8f7d54e-c6d2-44fe-b7ae-b489667f1f2e"},{"name":"Reservation Payload","item":[],"id":"5505e820-5121-4d60-9ba5-8dde52d9cac5","description":"

Example of Reservation Payload:

{\n  \"data\": {\n    \"id\": \"c4b43e13-2c2c-48ad-b1bc-c89446069d1a\",\n    \"type\": \"reservation\",\n    \"attributes\": {\n      \"key\": \"L1H40Z\",\n      \"restaurant_id\": \"63c6a71c-9e6e-420e-b290-d8b1b64fb1e5\",\n      \"covers\": 8,\n      \"duration\": 7200,\n      \"status\": \"confirmed\",\n      \"notes\": null,\n      \"walk_in\": false,\n      \"origin\": \"in_house\",\n      \"updated_by\": \"restaurant\",\n      \"created_by\": null,\n      \"idempotency_token\": null,\n      \"experience_id\": null,\n      \"comments\": [],\n      \"channel\": \"In House\",\n      \"prearrival\": false,\n      \"complete\": false,\n      \"canceled_status\": false,\n      \"start_time\": \"2024-03-26T20:15:00\",\n      \"end_time\": \"2024-03-26T22:15:00\",\n      \"confirmed_at\": null,\n      \"canceled_at\": null,\n      \"arrived_at\": null,\n      \"seated_at\": null,\n      \"check_dropped_at\": null,\n      \"finished_at\": null,\n      \"no_show_at\": null,\n      \"denied_at\": null,\n      \"created_at\": \"2024-03-26T12:05:07\",\n      \"updated_at\": \"2024-03-27T11:14:38\",\n      \"review\": {},\n      \"custom_fields\": {\n        \"custom_field_1\": \"custom_value_1\",\n        \"custom_field_2\": \"custom_value_2\"\n      }\n    },\n    \"relationships\": {\n      \"guest\": {\n        \"data\": {\n          \"id\": \"efe3d0c4-46c5-4ae2-840c-0a941f5a6305\",\n          \"type\": \"guest\"\n        }\n      },\n      \"tables\": {\n        \"data\": [\n          {\n            \"id\": \"13b7cbaf-9436-4e9b-907a-bf1e2a88a3d6\",\n            \"type\": \"table\"\n          },\n          {\n            \"id\": \"d59431c2-e21d-4f44-8128-60b6b0f2155e\",\n            \"type\": \"table\"\n          }\n        ]\n      },\n      \"payments\": {\n        \"data\": [\n          {\n            \"id\": \"7209f18c-f708-4e21-bd60-77a97a55f4ef\",\n            \"type\": \"payment\"\n          }\n        ]\n      },\n      \"tags\": {\n        \"data\": [\n          {\n            \"id\": \"47ba5e98-6bc7-4d93-9e59-796d50e5f25d\",\n            \"type\": \"tag\"\n          }\n        ]\n      },\n      \"pos_records\": {\n        \"data\": [\n          {\n            \"id\": \"625a65cf-9d4d-499c-97ca-c8ec5a660d87\",\n            \"type\": \"pos_record\"\n          }\n        ]\n      },\n      \"restaurant\": {\n        \"data\": {\n          \"id\": \"63c6a71c-9e6e-420e-b290-d8b1b64fb1e5\",\n          \"type\": \"restaurant\"\n        }\n      }\n    }\n  },\n  \"meta\": {\n    \"created_at\": 1711523679.830612,\n    \"number\": 257878,\n    \"event\": \"update_reservation\",\n    \"changes\": {\n      \"status\": ['confirmed', 'seated'],\n      \"table_ids\": [\n        [\n          \"10ce8760-75e8-4514-9f6f-508eace277ea\",\n          \"b9317712-574f-4abe-821c-593438ae1fab\",\n          \"0d120cb6-6ddc-4773-b231-b7c53cbaaeea\"\n        ],\n        [\n          \"b9317712-574f-4abe-821c-593438ae1fab\",\n          \"10ce8760-75e8-4514-9f6f-508eace277ea\",\n          \"0d120cb6-6ddc-4773-b231-b7c53cbaaeea\",\n          \"f5f5c319-a3e3-43d0-80e2-34346e858fd9\"\n        ]\n      ],\n      \"service_table_ids\": [\n        [\n          \"1\",\n          \"2\",\n          \"3\"\n        ],\n        [\n          \"1\",\n          \"2\",\n          \"3\",\n          \"4\"\n        ]\n      ]\n    }\n  },\n  \"included\": [\n    {\n      \"id\": \"13b7cbaf-9436-4e9b-907a-bf1e2a88a3d6\",\n      \"type\": \"table\",\n      \"attributes\": {\n        \"room_id\": \"37889bdd-f0d3-4920-bdaa-930fa1d1fa82\",\n        \"max_covers\": 4,\n        \"min_covers\": 1,\n        \"number\": \"11\",\n        \"pos_service_table_id\": \"357\",\n        \"rotation\": 0,\n        \"shape\": \"circle\",\n        \"size\": \"6x6\",\n        \"sold_online\": true,\n        \"created_at\": \"2023-01-11T16:56:06\",\n        \"updated_at\": \"2023-06-21T20:11:36\",\n        \"x\": 0.621739,\n        \"y\": 0.707971\n      },\n      \"relationships\": {}\n    },\n    {\n      \"id\": \"d59431c2-e21d-4f44-8128-60b6b0f2155e\",\n      \"type\": \"table\",\n      \"attributes\": {\n        \"room_id\": \"37889bdd-f0d3-4920-bdaa-930fa1d1fa82\",\n        \"max_covers\": 20,\n        \"min_covers\": 1,\n        \"number\": \"16\",\n        \"pos_service_table_id\": \"275\",\n        \"rotation\": 0,\n        \"shape\": \"rectangle\",\n        \"size\": \"3x3\",\n        \"sold_online\": true,\n        \"created_at\": \"2023-03-14T16:28:38\",\n        \"updated_at\": \"2023-06-21T20:11:36\",\n        \"x\": 0.389855,\n        \"y\": 0.545652\n      },\n      \"relationships\": {}\n    },\n    {\n      \"id\": \"7209f18c-f708-4e21-bd60-77a97a55f4ef\",\n      \"type\": \"payment\",\n      \"attributes\": {\n        \"restaurant_id\": \"63c6a71c-9e6e-420e-b290-d8b1b64fb1e5\",\n        \"status\": \"captured\",\n        \"description\": \"A payment is required to hold the slot for this reservation\",\n        \"gateway\": \"checkout\",\n        \"gateway_message\": {\n          \"code\": \"10043\",\n          \"status\": \"Declined\",\n          \"message\": \"Insufficient funds\"\n        },\n        \"charge_strategy\": \"smart\",\n        \"currency\": \"USD\",\n        \"source\": \"web\",\n        \"card_brand\": \"Master\",\n        \"card_last4\": \"4242\",\n        \"notes\": \"Architecto nisi explicabo est.\",\n        \"capture_url\": null,\n        \"refund_url\": \"https://api.eatapp.co/services/payments/v2/payments/7209f18c-f708-4e21-bd60-77a97a55f4ef/refund\",\n        \"void_url\": null,\n        \"cancel_url\": null,\n        \"payment_widget_url\": \"https://eatapp.co/pay/L1H40Z\",\n        \"status_under_process\": null,\n        \"guest_first_name\": \"Jason\",\n        \"guest_last_name\": \"Gamble\",\n        \"guest_email\": \"example@example.com\",\n        \"guest_phone\": \"+971555555555\",\n        \"amount\": 915.2,\n        \"gateway_actions\": [\n          {\n            \"id\": \"58658c7b2e5ec3044d2ff535691e9d87\",\n            \"date\": \"2024-03-26T08:05:38Z\",\n            \"type\": \"Authorized\",\n            \"amount\": \"8.32 USD\",\n            \"response_code\": \"10000\",\n            \"response_message\": \"Est vitae dicta et.\"\n          },\n          {\n            \"id\": \"55252cb89c566e50c43187820d8481eb\",\n            \"date\": \"2024-03-26T08:05:38Z\",\n            \"type\": \"Captured\",\n            \"amount\": \"8.32 USD\",\n            \"response_code\": \"10000\",\n            \"response_message\": \"Doloremque ut ea ipsam.\"\n          }\n        ],\n        \"external_gateway\": false,\n        \"may_update\": false,\n        \"reservation_id\": \"c4b43e13-2c2c-48ad-b1bc-c89446069d1a\",\n        \"may_send_reminder\": false,\n        \"created_at\": \"2024-03-26T12:05:08\",\n        \"updated_at\": \"2024-03-26T12:05:11\",\n        \"requested_at\": \"2024-03-26T12:05:08\",\n        \"authorized_at\": \"2024-03-26T12:05:08\",\n        \"captured_at\": \"2024-03-26T12:05:08\",\n        \"refunded_at\": null,\n        \"refund_requested_at\": null,\n        \"voided_at\": null,\n        \"canceled_at\": null,\n        \"auto_cancel_at\": null,\n        \"authorized_payment_expires_at\": null\n      },\n      \"relationships\": {}\n    },\n    {\n      \"id\": \"625a65cf-9d4d-499c-97ca-c8ec5a660d87\",\n      \"type\": \"pos_record\",\n      \"attributes\": {\n        \"restaurant_id\": \"63c6a71c-9e6e-420e-b290-d8b1b64fb1e5\",\n        \"pos_service_id\": \"176362841\",\n        \"reservation_id\": \"c4b43e13-2c2c-48ad-b1bc-c89446069d1a\",\n        \"manual_match\": true,\n        \"data\": {\n          \"payments\": [\n            {\n              \"id\": \"121\",\n              \"tip\": 0,\n              \"type\": \"credit card\",\n              \"value\": 54.48,\n              \"pos_id\": null,\n              \"comment\": null\n            }\n          ],\n          \"table_id\": \"549\",\n          \"discounts\": [\n            {\n              \"id\": \"884\",\n              \"name\": \"sonsing\",\n              \"type\": \"dollar\",\n              \"value\": 7.41,\n              \"pos_id\": \"112\",\n              \"comment\": null\n            }\n          ],\n          \"ticket_id\": \"176362841\",\n          \"menu_items\": [\n            {\n              \"id\": \"813\",\n              \"name\": \"Chicken Fajitas\",\n              \"price\": 19.23,\n              \"pos_id\": \"227\",\n              \"comment\": \"Et consequatur unde.\",\n              \"quantity\": 1,\n              \"modifiers\": [\n                {\n                  \"id\": \"561\",\n                  \"name\": \"Soy Milk\",\n                  \"price\": 12.71,\n                  \"pos_id\": \"289\",\n                  \"comment\": \"Deserunt consequatur est.\",\n                  \"quantity\": 1,\n                  \"menu_categories\": []\n                }\n              ],\n              \"menu_categories\": []\n            },\n            {\n              \"id\": \"130\",\n              \"name\": \"Lasagne\",\n              \"price\": 17.04,\n              \"pos_id\": \"388\",\n              \"comment\": \"Quia aut illum.\",\n              \"quantity\": 1,\n              \"modifiers\": [\n                {\n                  \"id\": \"131\",\n                  \"name\": \"Soba\",\n                  \"price\": 10.32,\n                  \"pos_id\": \"559\",\n                  \"comment\": null,\n                  \"quantity\": 1,\n                  \"menu_categories\": []\n                }\n              ],\n              \"menu_categories\": []\n            }\n          ],\n          \"table_name\": \"549\",\n          \"employee_id\": \"210\",\n          \"ticket_name\": null,\n          \"ticket_open\": false,\n          \"ticket_void\": true,\n          \"table_number\": 549,\n          \"table_pos_id\": \"549\",\n          \"voided_items\": [],\n          \"order_type_id\": \"166\",\n          \"ticket_number\": \"959672773\",\n          \"commercial_due\": 0,\n          \"commercial_paid\": 54.48,\n          \"commercial_tips\": 0,\n          \"employee_pos_id\": \"781\",\n          \"order_type_name\": \"Italian\",\n          \"service_charges\": [],\n          \"commercial_total\": 54.48,\n          \"ticket_closed_at\": \"2024-03-26T09:25:35\",\n          \"ticket_opened_at\": \"2024-03-26T09:15:00\",\n          \"order_type_pos_id\": \"175\",\n          \"employee_last_name\": \"Kub\",\n          \"employee_check_name\": \"FrancineKub\",\n          \"employee_first_name\": \"Francine\",\n          \"commercial_sub_total\": 51.89,\n          \"commercial_tax_total\": 2.59,\n          \"commercial_guest_count\": 3,\n          \"commercial_items_total\": 59.3,\n          \"commercial_payment_type\": \"credit card\",\n          \"commercial_dicount_total\": 7.41,\n          \"commercial_payment_comments\": null,\n          \"commercial_revenue_center_id\": \"696\",\n          \"commercial_inclusive_tax_total\": 0,\n          \"commercial_other_charges_total\": 0,\n          \"commercial_revenue_center_name\": \"Ramen\",\n          \"commercial_revenue_center_pos_id\": \"736\",\n          \"commercial_service_charges_total\": 0\n        },\n        \"created_at\": \"2024-03-26T12:05:08\",\n        \"updated_at\": \"2024-03-26T12:23:24\"\n      },\n      \"relationships\": {}\n    },\n    {\n      \"id\": \"47ba5e98-6bc7-4d93-9e59-796d50e5f25d\",\n      \"type\": \"tag\",\n      \"attributes\": {\n        \"name\": \"Birthday\",\n        \"type\": \"Guest\",\n        \"restaurant_id\": \"63c6a71c-9e6e-420e-b290-d8b1b64fb1e5\",\n        \"created_at\": \"2021-06-30T14:00:05\",\n        \"updated_at\": \"2024-03-26T12:39:09\"\n      },\n      \"relationships\": {}\n    },\n    {\n      \"id\": \"476b8b51-1070-4e6c-ae11-61070e275489\",\n      \"type\": \"tag\",\n      \"attributes\": {\n        \"name\": \"High Spender\",\n        \"type\": \"Guest\",\n        \"restaurant_id\": \"63c6a71c-9e6e-420e-b290-d8b1b64fb1e5\",\n        \"created_at\": \"2020-10-14T11:43:05\",\n        \"updated_at\": \"2024-03-26T12:32:52\"\n      },\n      \"relationships\": {}\n    },\n    {\n      \"id\": \"efe3d0c4-46c5-4ae2-840c-0a941f5a6305\",\n      \"type\": \"guest\",\n      \"attributes\": {\n        \"restaurant_id\": \"63c6a71c-9e6e-420e-b290-d8b1b64fb1e5\",\n        \"first_name\": \"Jason\",\n        \"last_name\": \"Gamble\",\n        \"phone\": \"+971505000000\",\n        \"email\": \"jason@mailinator.com\",\n        \"alt_email\": null,\n        \"alt_phone\": null,\n        \"notes\": \"Note...\",\n        \"birthday\": null,\n        \"anniversary\": null,\n        \"pos_data\": {\n          \"total_spend\": 0,\n          \"visit_count\": 0,\n          \"average_spend_per_cover\": 0,\n          \"average_spend_per_visit\": 0\n        },\n        \"visit_data\": {\n          \"last_visit\": \"2024-03-26T16:15:00\",\n          \"next_visit\": \"2024-03-28T21:45:00\",\n          \"first_visit\": \"2024-02-19T18:00:00\",\n          \"visit_count\": 2,\n          \"denied_count\": 0,\n          \"visit_covers\": 10,\n          \"denied_covers\": 0,\n          \"next_visit_id\": \"dbdd08e7-d5df-4ad9-828e-349feda6979b\",\n          \"no_show_count\": 0,\n          \"reviews_count\": 0,\n          \"canceled_count\": 0,\n          \"no_show_covers\": 0,\n          \"canceled_covers\": 0,\n          \"reviews_average_rating\": 0,\n          \"reviews_average_food_rating\": 0,\n          \"upcoming_reservations_count\": 2,\n          \"reviews_average_service_rating\": 0,\n          \"reviews_average_ambience_rating\": 0\n        },\n        \"profile_image_url\": null,\n        \"title\": null,\n        \"gender\": \"male\",\n        \"organisation\": \"Demo\",\n        \"job_title\": \"Dr\",\n        \"profession\": null,\n        \"address\": null,\n        \"loyalty_sid\": null,\n        \"visit_count\": 2,\n        \"cancellation_count\": 0,\n        \"no_show_count\": 0,\n        \"imported_reservation_count\": 0,\n        \"shared_key\": \"75320ae1-151d-4869-96b2-360a60add4e2\",\n        \"created_at\": \"2024-02-19T19:43:06\",\n        \"updated_at\": \"2024-03-27T11:14:38\",\n        \"terms_and_conditions_accepted_at\": \"2024-02-19T19:43:06\",\n        \"marketing_accepted_at\": \"2024-02-19T19:43:06\",\n        \"custom_fields\": {\n          \"custom_field_1\": \"custom_value_1\",\n          \"custom_field_2\": \"custom_value_2\"\n        }\n      },\n      \"relationships\": {\n        \"tags\": {\n          \"data\": [\n            {\n              \"id\": \"476b8b51-1070-4e6c-ae11-61070e275489\",\n              \"type\": \"tag\"\n            }\n          ]\n        },\n        \"pos_records\": {\n          \"data\": [\n            {\n              \"id\": \"625a65cf-9d4d-499c-97ca-c8ec5a660d87\",\n              \"type\": \"pos_record\"\n            }\n          ]\n        },\n        \"payments\": {\n          \"data\": [\n            {\n              \"id\": \"7209f18c-f708-4e21-bd60-77a97a55f4ef\",\n              \"type\": \"payment\"\n            }\n          ]\n        }\n      }\n    },\n    {\n      \"id\": \"63c6a71c-9e6e-420e-b290-d8b1b64fb1e5\",\n      \"type\": \"restaurant\",\n      \"attributes\": {\n        \"name\": \"Ali Cafe\",\n        \"difficult\": false\n      },\n      \"relationships\": {}\n    }\n  ]\n}\n\n

Reservation Attributes

Key	Details
`data.id`	Unique identifier for the reservation
`data.type`	The type of the resource being handled
`key`	Reservation unique key, used to easy share and find reservation data
`restaurant_id`	Restaurant ID
`covers`	Number of People in the reservation
`duration`	Duration of the reservation in seconds
`status`	Status of the reservation, statuses can be predefined or dynamic, restaurants can add custom statues
`notes`	Additional notes related to the reservation
`walk_in`	Indicates if the reservation is a walk-in
`origin`	Source of the reservation (in-house, online, mobile)
`updated_by`	Who last updated the reservation (e.g., restaurant, system)
`created_by`	Who created the reservation
`idempotency_token`	Token to ensure the request is idempotent (not repeated)
`experience_id`	Identifier for any special experience associated with the reservation
`comments`	List of comments about the reservation
`channel`	Channel from which the reservation was made, check the references below.
`prearrival`	Check if the reservation status is in pre-arrival (`wait_list`, `not_confirmed`, `no_answer`, `confirmed`, `late`, `partially_arrived` )
`complete`	Check if the reservation status is in completed (`no_show`, `canceled`, `denied`, `finished`)
`canceled_status`	Check if the reservation status is in canceled (`canceled`, `denied`, `no_show`)
`start_time`	Reservation Start Time
`end_time`	Reservation End Time (depends on the duration)
`custom_fields`	Guest Custom fields, in JSON format
`confirmed_at`	Timestamp when the reservation was confirmed (will be deprecated)
`canceled_at`	Timestamp when the reservation was canceled (will be deprecated)
`arrived_at`	Timestamp when the guest arrived (will be deprecated)
`seated_at`	Timestamp when the guest was seated (will be deprecated)
`check_dropped_at`	Timestamp when the check was dropped at the table (will be deprecated)
`finished_at`	Timestamp when the guest finished the reservation (will be deprecated)
`no_show_at`	Timestamp when the guest was marked as a no-show (will be deprecated)
`denied_at`	Timestamp when the guest was denied the reservation (will be deprecated)
`created_at`	Timestamp when the reservation was created
`updated_at`	Timestamp when the reservation was last updated
`review`	Review details of the reservation (if available)

Origins:

mobile : Made via EatApp B2C App
\n
web : Online reservation, via the widget or any partner
\n
in_house : Made manually via EatApp B2B App
\n

Booking Channels:

Google : Made via Google integration
\n
Customer API : Via Concierge partner
\n
Booking Widget : Via EatApp widget
\n
Eat : Made via any of EatApp Channels
\n
Online Orders : Made via Online Order
\n
Web : any reservation that dose not fall into the channels above will be marked as eat
\n

Pre Defined Statues:

wait_list
\n
not_confirmed
\n
no_answer
\n
confirmed
\n
late
\n
partially_arrived
\n
arrived
\n
seated
\n
appetizer
\n
entree
\n
dessert
\n
check_dropped
\n
finished
\n
canceled
\n
denied
\n
no_show
\n

Note: Statuses are dynamic, restaurants can define custom statuses.

Deprecation:

statuses time stamps (${status}_at) will be deprecated, we recommend not relying on them.

Relationships

Reservation object has some relationships, all relationships can be present or not, depends on the reservation attached data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

key	Type	Presence
guest	Single Guest	One
tables	Tables	Multi
payments	Payments (Eat App Payments)	Multi
tags	Tag	Multi
pos_records	POS Records / Ticket	Multi

Guest

Referee to the Guest Webhook documentation

Tag

Referee to the Guest Webhook documentation -> Tag

Restaurant

Referee to the Guest Webhook documentation -> Restaurant

Table Attributes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Details
`data.id`	Unique identifier for the reservation
`data.type`	The type of the resource being handled
`number`	Table number/name
`room_id`	Room ID
`max_covers`	Maximum number of covers this table can seat
`min_covers`	Minimum number of covers this table can seat
`sold_online`	Is the table available for online reservations?
`pos_service_table_id`	The mapped POS table id
`x`	Table position in the floor canvas
`y`	Table position in the floor canvas
`size`	Table size in the floor canvas
`rotation`	Table rotation in the floor canvas
`shape`	Table shape in the floor canvas
`created_at`	Timestamp when the table was created
`updated_at`	Timestamp when the table was update

Payment Attributes

Key	Details
`data.id`	Unique identifier for the payment
`data.type`	Type of resource, which is \"payment\"
`restaurant_id`	Restaurant ID
`status`	Payment status, check the payment statuses list below
`description`	Description of the payment purpose
`gateway`	Payment gateway used for processing the payment, (`stripe`, `checkout`, `adyen` ...)
`gateway_message.code`	Gateway response code
`gateway_message.status`	Gateway status (e.g., declined, approved)
`gateway_message.message`	Message from the payment gateway (e.g., reason for decline)
`charge_strategy`	Payment strategy used (e.g., smart, manual)
`currency`	Currency of the payment (e.g., USD)
`source`	Source from where the payment originated (e.g., web, mobile)
`card_brand`	Brand of the card used for payment (e.g., Master)
`card_last4`	Last four digits of the card used for payment
`notes`	Additional notes about the payment
`capture_url`	URL for capturing the payment, if applicable
`refund_url`	URL for refunding the payment, if applicable
`void_url`	URL for voiding the payment, if applicable
`cancel_url`	URL for canceling the payment, if applicable
`payment_widget_url`	URL for the payment widget used by the customer
`status_under_process`	Status indicating if the payment is under processing
`guest_first_name`	First name of the guest associated with the payment
`guest_last_name`	Last name of the guest associated with the payment
`guest_email`	Email address of the guest
`guest_phone`	Phone number of the guest
`amount`	Total payment amount
`gateway_actions`	The History of actions taken by the payment gateway (e.g., authorized, captured)
`gateway_actions.id`	Unique identifier for the gateway action
`gateway_actions.date`	Timestamp of when the gateway action occurred
`gateway_actions.type`	Type of gateway action (e.g., Authorized, Captured)
`gateway_actions.amount`	Amount processed in each gateway action
`gateway_actions.response_code`	Gateway response code for each action
`gateway_actions.response_message`	Gateway response message for each action
`external_gateway`	Indicates if the payment is managed externally by a partner, not via the supported gateways
`reservation_id`	Unique identifier for the associated reservation
`may_update`	Indicates whether the payment details can be updated
`may_send_reminder`	Indicates whether a payment reminder can be sent
`created_at`	Timestamp when the payment was created
`updated_at`	Timestamp when the payment was last updated
`requested_at`	Timestamp when the payment was requested
`authorized_at`	Timestamp when the payment was authorized
`captured_at`	Timestamp when the payment was captured
`refunded_at`	Timestamp when the payment was refunded
`refund_requested_at`	Timestamp when a refund was requested
`voided_at`	Timestamp when the payment was voided
`canceled_at`	Timestamp when the payment was canceled
`auto_cancel_at`	Timestamp when the payment was automatically canceled
`authorized_payment_expires_at`	Timestamp when the authorization for the payment expires

Payment Statuses:

requested
\n
authorized
\n
captured
\n
refunded
\n
voided
\n
canceled
\n
partially_refunded
\n
failed
\n

Charge Strategies:

smart: Automatically decide either to authorize or capture the payment based on the difference between current day vs. reservation start time
\n
authorization
\n
pre_payment
\n
save_card
\n

POS Record Attributes

POS Record data is dependent on the integration. Certain fields may be unavailable or not provided while the ticket remains open, and they may be populated at a later stage. Additionally, some integrations may not supply specific data fields at all.

Key	Explanation
`id`	Unique identifier for the POS record
`type`	Type of resource, which is \"pos_record\"
`restaurant_id`	Restaurant ID
`pos_service_id`	POS system ticket ID
`reservation_id`	Reservation ID (available if the ticket was already matched to a reservation)
`manual_match`	Indicates whether the POS record was manually matched
`data.payments`	List of payment transactions captured by POS system (if available)
`data.payments.id`	POS Payment Transaction ID
`data.payments.tip`	Tip amount provided in the payment (if available)
`data.payments.type`	Type of payment (e.g., `credit card`, `cash`)
`data.payments.value`	Payment amount
`data.payments.pos_id`	POS identifier for the payment (if available)
`data.payments.comment`	Comments or notes related to the payment
`data.table_id`	Identifier for the table associated with the POS record
`data.discounts`	List of discounts applied during the transaction (if available)
`data.discounts.id`	Discount ID
`data.discounts.name`	Name of the discount applied
`data.discounts.type`	Type of discount (e.g., dollar, percentage)
`data.discounts.value`	Value of the discount applied
`data.discounts.pos_id`	POS identifier for the discount (if available)
`data.discounts.comment`	Comments or notes related to the discount
`data.ticket_id`	ID for the POS ticket
`data.menu_items`	List of menu items included in the transaction
`data.menu_items.id`	ID for the menu item
`data.menu_items.name`	Name of the menu item
`data.menu_items.price`	Price of the menu item
`data.menu_items.pos_id`	POS identifier for the menu item
`data.menu_items.comment`	Comments or notes related to the menu item
`data.menu_items.quantity`	Quantity of the menu item ordered
`data.menu_items.modifiers`	List of modifiers applied to the menu item
`data.menu_items.modifiers.id`	ID for the modifier
`data.menu_items.modifiers.name`	Name of the modifier applied to the menu item
`data.menu_items.modifiers.price`	Price of the modifier
`data.menu_items.modifiers.pos_id`	POS identifier for the modifier
`data.menu_items.modifiers.comment`	Comments or notes related to the modifier
`data.table_name`	Name or identifier for the table
`data.employee_id`	ID for the employee handling the transaction
`data.ticket_open`	Indicates whether the POS ticket is currently open
`data.ticket_void`	Indicates whether the POS ticket has been voided
`data.table_number`	Number assigned to the table associated with the transaction
`data.table_pos_id`	POS identifier for the table
`data.voided_items`	List of items that have been voided in the transaction
`data.order_type_id`	ID for the type of order (e.g., dine-in, takeout)
`data.ticket_number`	Number of the POS ticket
`data.commercial_due`	Amount due for the transaction
`data.commercial_paid`	Amount paid for the transaction
`data.commercial_tips`	Total tips provided in the transaction
`data.employee_pos_id`	POS identifier for the employee handling the transaction
`data.order_type_name`	Name of the order type (e.g., Italian, Mexican)
`data.service_charges`	List of service charges applied to the transaction
`data.commercial_total`	Total commercial value of the transaction
`data.ticket_closed_at`	Timestamp when the POS ticket was closed
`data.ticket_opened_at`	Timestamp when the POS ticket was opened
`data.order_type_pos_id`	POS identifier for the order type
`data.employee_last_name`	Last name of the employee handling the transaction
`data.employee_check_name`	Name used by the employee when checking the ticket
`data.employee_first_name`	First name of the employee handling the transaction
`data.commercial_sub_total`	Subtotal of the commercial items in the transaction
`data.commercial_tax_total`	Total tax applied to the transaction
`data.commercial_guest_count`	Number of guests involved in the transaction
`data.commercial_items_total`	Total value of the items in the transaction
`data.commercial_payment_type`	Type of payment used for the transaction (e.g., credit card)
`data.commercial_dicount_total`	Total discounts applied to the transaction
`data.commercial_payment_comments`	Comments related to the payment process
`data.commercial_revenue_center_id`	ID for the revenue center
`data.commercial_inclusive_tax_total`	Total inclusive tax applied to the transaction
`data.commercial_other_charges_total`	Total other charges applied to the transaction
`data.commercial_revenue_center_name`	Name of the revenue center
`data.commercial_revenue_center_pos_id`	POS identifier for the revenue center
`data.commercial_service_charges_total`	Total service charges applied to the transaction
`created_at`	Timestamp when the POS record was created
`updated_at`	Timestamp when the POS record was last updated

","_postman_id":"5505e820-5121-4d60-9ba5-8dde52d9cac5"}],"event":[{"listen":"prerequest","script":{"id":"e58eba4d-1f81-4c22-a138-11598fd41618","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5f45fd3f-d0e1-4032-98a7-cc7beb621c1c","type":"text/javascript","exec":[""]}}]}