Update webhook configuration

patch https://api.kitchenhub.app/v2/webhooks/{webhook_id}/

Path Params

webhook_id

string

required

Id of your webhook

Query Params

request

string

Body Params

webhook_url

string

Url in your system where we send orders or different notifications

authorization_headers

object

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

filters

object

required

    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"]

webhook_type

string

An enumeration.

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

Responses

200

Success Response

Language

Credentials

Header


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://api.kitchenhub.app/v2/webhooks/webhook_id/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here!

401Unauthorized

403Forbidden

404Partner webhook not found

422Validation error

500Server error