Public API

Event Notifications

2min

Once you have set up your integration, you will begin to receive Event Notifications for any Subscriptions you have set up. Notifications will be sent to the webhookUrl specified during Subscriber creation. The notifications will provide basic information about the event that occurred, but for detailed information, you can query the Public API.
Example Notification Payload
GraphQL
{
     “id”: “[uuid of the notification]”,
     “parent_type”: “Caterer”,
     “parent_id”: “[uuid of the caterer]”,
     “entity_type”: “Order”,
     “entity_id”: “[uuid of the order]”,
     “key”: [“accepted”,]OR[“cancelled”,]
     “occurred_at”: “[time]”
}
{
     “id”: “[uuid of the notification]”,
     “parent_type”: “Caterer”,
     “parent_id”: “[uuid of the caterer]”,
     “entity_type”: “Order”,
     “entity_id”: “[uuid of the order]”,
     “key”: [“accepted”,]OR[“cancelled”,]
     “occurred_at”: “[time]”
}
﻿
At this time we are only supporting Order Accepted and Order Cancelled notifications. We will communicate changes as more notification types are added.
﻿

Updated 05 Dec 2024

Did this page help you?

Querying the Public API

Troubleshooting