This document is targeted for third-party services integrating with the Open Dining platform. Open Dining can send HTTP POST notifications to third-party systems when orders are submitted.
Currently, webhooks must be configured by the Open Dining support team. Shoot an email to help@opendining.net with the full URL and restaurant name that you'd like to receive webhook notifications, and we'll set it up for you.
The notification will be sent via HTTP POST with an application/x-www-form-urlencoded Content-Type. The following fields will be present in the POST body:
| Property | Description |
|---|---|
| action | For orders, this will always be new_order |
| order | The order ID |
| restaurant | The restaurant ID |
| order_data | This field contains the entire order's contents. See the API Reference for detailed descriptions of each field. |
action=new_order&restaurant=4c93b92d7a8d884d0a000000&order=564bbe42515ee9d9247b23c9&order_data%5Bname%5D=Open+Bistro&order_data%5Brestaurant%5D=4c93b92d7a8d884d0a000000&order_data%5Bcreation_time%5D=11%2F17%2F2015+06%3A54%3A43&order_data%5Bstatus%5D=Submitted&order_data%5Bs%5D=3&order_data%5Bc%5D=0&order_data%5Bpaid%5D=1ahOZBYuGzEsw7HHGzAWVml0IRd&order_data%5Btype%5D=takeout&order_data%5Bsubmit_url%5D=https%3A%2F%2Fwww.opendining.net%2Fsubmit%2F564bbe42515ee9d9247b23c9&order_data%5Bitems%5D%5B0%5D%5Bid%5D=564bbe48515ee94a257b23c6&order_data%5Bitems%5D%5B0%5D%5Bmenuitem%5D=4e57b5a2988d88ff0c000000&order_data%5Bitems%5D%5B0%5D%5Bname%5D=Bacon+Wrapped+Scallops+with+Shrimp&order_data%5Bitems%5D%5B0%5D%5Bquantity%5D=1&order_data%5Bitems%5D%5B0%5D%5Boptions%5D%5B0%5D%5Bname%5D=Extras%3A+Extra+Meat&order_data%5Bitems%5D%5B0%5D%5Boptions%5D%5B0%5D%5Bprice%5D=1&order_data%5Bitems%5D%5B0%5D%5Boptions%5D%5B0%5D%5Bpos%5D=&order_data%5Bitems%5D%5B0%5D%5Boptions%5D%5B0%5D%5Bprices%5D%5BNormal%5D=&order_data%5Bitems%5D%5B0%5D%5Boptions%5D%5B0%5D%5Bcpos%5D%5BNormal%5D=&order_data%5Bitems%5D%5B0%5D%5Boptions%5D%5B0%5D%5Bis_default%5D=0&order_data%5Bitems%5D%5B0%5D%5Boptions%5D%5B0%5D%5Bis_disabled%5D=0&order_data%5Bitems%5D%5B0%5D%5Boptions%5D%5B0%5D%5Bquantity%5D=1&order_data%5Bitems%5D%5B0%5D%5Boptions%5D%5B0%5D%5Bgroup_name%5D=Extras&order_data%5Bitems%5D%5B0%5D%5Bcategory%5D=Small+Plates&order_data%5Bitems%5D%5B0%5D%5Border_type%5D=both&order_data%5Bitems%5D%5B0%5D%5Bprice%5D=10.99&order_data%5Bitems%5D%5B0%5D%5Btotal_price%5D=11.99&order_data%5Bitems%5D%5B0%5D%5Bsize%5D=Normal&order_data%5Bitems%5D%5B0%5D%5Ballergens%5D%5B0%5D=seafood&order_data%5Bitems%5D%5B0%5D%5Ballergens%5D%5B1%5D=peanuts&order_data%5Bitems%5D%5B1%5D%5Bid%5D=564bbe49515ee963257b23c7&order_data%5Bitems%5D%5B1%5D%5Bmenuitem%5D=4fc450c4000d97ad2e000111&order_data%5Bitems%5D%5B1%5D%5Bname%5D=Chocolate+Cake&order_data%5Bitems%5D%5B1%5D%5Bquantity%5D=1&order_data%5Bitems%5D%5B1%5D%5Bcategory%5D=Desserts&order_data%5Bitems%5D%5B1%5D%5Border_type%5D=both&order_data%5Bitems%5D%5B1%5D%5Bprice%5D=4.99&order_data%5Bitems%5D%5B1%5D%5Btotal_price%5D=4.99&order_data%5Bitems%5D%5B1%5D%5Bsize%5D=Normal&order_data%5Bitems%5D%5B1%5D%5Bxs%5D=1&order_data%5Bfee%5D=&order_data%5Btotal_amount%5D=20.7&order_data%5Btax%5D=1.02&order_data%5Bsubtotal%5D=16.98&order_data%5Bdelivery_fee%5D=0&order_data%5Btime%5D=15&order_data%5Bshort_id%5D=38469&order_data%5Bsubmit_time%5D=11%2F17%2F2015+06%3A55%3A06&order_data%5Bu%5D=help%40opendining.net&order_data%5Bcustomer_name%5D=Tim+Ridgely&order_data%5Bcustomer_phone%5D=1112223333&order_data%5Bcard%5D%5Btype%5D=visa&order_data%5Bcard%5D%5Bdigits%5D=1111&order_data%5Bcard%5D%5Bmonth%5D=11&order_data%5Bcard%5D%5Byear%5D=2018&order_data%5Bcard%5D%5Btoken%5D=POpsm8gVzPBAup76hzxHpWjJm0I&order_data%5Bdue_timestamp%5D=1447805406&order_data%5Btip%5D=2.7&order_data%5Bfields%5D%5B0%5D%5Bname%5D=Do+You+Want+Silverware%3F&order_data%5Bfields%5D%5B0%5D%5Bvalue%5D=&order_data%5Bid%5D=564bbe42515ee9d9247b23c9&order_data%5Bsubmit_now%5D=1&order_data%5Basap_lead_time%5D=15
action: new_order
order: 564bbe42515ee9d9247b23c9
restaurant: 4c93b92d7a8d884d0a000000
order_data[card][digits]: 1111
order_data[card][type]: visa
order_data[card][year]: 2018
order_data[card][token]: POpsm8gVzPBAup76hzxHpWjJm0I
order_data[restaurant]: 4c93b92d7a8d884d0a000000
order_data[id]: 564bbe42515ee9d9247b23c9
order_data[items][0][name]: Bacon Wrapped Scallops with Shrimp
order_data[items][0][price]: 10.99
order_data[items][0][total_price]: 11.99
order_data[items][0][menuitem]: 4e57b5a2988d88ff0c000000
order_data[items][0][allergens][1]: peanuts
order_data[items][0][quantity]: 1
order_data[items][0][category]: Small Plates
order_data[items][0][options][0][is_disabled]: 0
order_data[items][0][options][0][price]: 1
order_data[items][0][options][0][pos]:
order_data[items][0][options][0][is_default]: 0
order_data[items][0][options][0][quantity]: 1
order_data[items][0][options][0][name]: Extras: Extra Meat
order_data[items][0][options][0][cpos][Normal]:
order_data[items][0][options][0][group_name]: Extras
order_data[items][0][options][0][prices][Normal]:
order_data[items][0][order_type]: both
order_data[items][0][size]: Normal
order_data[items][0][allergens][0]: seafood
order_data[items][0][id]: 564bbe48515ee94a257b23c6
order_data[items][1][price]: 4.99
order_data[items][1][id]: 564bbe49515ee963257b23c7
order_data[items][1][menuitem]: 4fc450c4000d97ad2e000111
order_data[items][1][order_type]: both
order_data[items][1][category]: Desserts
order_data[items][1][name]: Chocolate Cake
order_data[items][1][quantity]: 1
order_data[items][1][total_price]: 4.99
order_data[items][1][size]: Normal
order_data[fields][0][name]: Do You Want Silverware?
order_data[fields][0][value]:
order_data[tip]: 2.7
order_data[status]: Submitted
order_data[submit_url]: https://www.opendining.net/submit/564bbe42515ee9d9247b23c9
order_data[creation_time]: 11/17/2015 06:54:43
order_data[total_amount]: 20.7
order_data[asap_lead_time]: 15
order_data[type]: takeout
order_data[tax]: 1.02
order_data[fee]:
order_data[customer_phone]: 1112223333
order_data[short_id]: 38469
order_data[time]: 15
order_data[subtotal]: 16.98
order_data[submit_now]: 1
order_data[submit_time]: 11/17/2015 06:55:06
order_data[due_timestamp]: 1447805406
order_data[card][month]: 11
order_data[paid]: 1ahOZBYuGzEsw7HHGzAWVml0IRd
order_data[customer_name]: Tim Ridgely
order_data[s]: 3
order_data[u]: help@opendining.net
order_data[name]: Open Bistro
order_data[c]: 0
order_data[delivery_fee]: 0