Create webhook

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

Create webhook. Where we will send notifications.

Query Params

request

string

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

required

An enumeration.

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

Response body

object

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

required

An enumeration.

Order MenuIntegrationStatus IntegrationAccount Delivery Cook

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

Has additional fields

webhook_id

string

required

Webhook id

created_at

date-time

required

Date and time of webhook creation

updated_at

date-time

Date and time of webhook update

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.kitchenhub.app/v2/webhooks/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "webhook_type": "Order"
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Success Response

400Bad request

401Unauthorized

403Forbidden

422Validation error

500Server error