Webhooks API

Overview

The Kitchenhub API includes webhooks for incoming orders and store notifications. In order for your service to receive webhooks from Kitchenhub, set your webhook URL and rules via webhook API. It is also possible to set up multiple webhooks if you need them.

Type of webhook notifications

We support 2 types of webhook notifications for orders and store status.

If you need to get real-time order notifications and update its status you have to get this type of notification.

You can manage what type of orders you want to get and in which statuses by managing the setting of a webhook via webhook API. For example, you can use it, if you need to get orders only in new status and only if they are for delivery, but not for pickup.

You can also get the second type of notification when stores are going offline on the provider side. Here is an example of this notification

Example of store notification:

JSON

{  
  "event_data": {  
    "event_type": "Alert",  
    "status": "AccountDisabled"  
  },  
  "alert": {  
    "message": "Account has been disabled",  
    "provider": "DoorDash",  
    "company": "company_id",  
    "kh_store_id": "",  
    "provider_store_id": "",  
    "dashboard_url": ""  
  }  
}