Create webhook

post

https://api.kitchenhub.app/v2/webhooks/

Create webhook. Where we will send notifications.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

url

string

required

Url in your system where we send orders or different notifications

version

integer

required

1 to 2

Payload which we are sending on your webhook depends on version.For Order events you can use 1 or 2.For Other events you can use only 1

webhook_type

string

enum

required

Webhook type

Allowed:

filters

object

    Necessary field, that can take such params as order_status, order_type, order_delivery_type
    Empty dict means that all filters will be suitable
    And list of supported values for example:
        "order_status": ["new", "accepted", "completed", "cancelled"]
        "order_type": ["pickup", "delivery", "dinein"],
        "order_delivery_type": ["restaurant"],

authorization_headers

object

Headers for authorization on your side which we will send with orders

Responses

201Success Response

400Bad request

401Unauthorized

403Forbidden

422Validation error

424Error on provider side. Please try again later

500Technical error. Please contact support to resolve this issue

501Provider is not supported or not implemented yet