Get webhooks

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

Get webhooks configuration

Responses

Response body

array of objects

ListClientWebhookConfig

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 GET \
2
     --url https://api.kitchenhub.app/v2/webhooks/ \
3
     --header 'accept: application/json'

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

application/json

200Success Response

401Unauthorized

403Forbidden

500Server error