Channel Registration

post

https://yourwebhook.com/channel/register

Purpose

To support customer onboardings, the webhook events below will communicate a stores status which instructs the channel to update the corresponding status on their side.

Response Body

With the "status": "register" we always expect a JSON result which contains all the supported endpoints detailed in the table below;

Attribute	Purpose	Type	Required
`statusUpdateURL`	Receive Order Status Update events	string	YES
`menuUpdateURL`	Receive Menu Update requests	string	YES
`snoozeUnsnoozeURL`	Receive both Snooze / Unsnooze Products requests	string	YES
`busyModeURL`	Receive Busy mode requests (paused/online)	string	YES
`updatePrepTimeURL`	Receive Preparation Time Update requests	string	NO
`courierUpdateURL`	Receive Courier Update events	string	NO
`paymentUpdateURL`	Received Payment Update events	string	NO
`authorizationURL`	Receive SSO Authorization requests	string	NO
`menuUrl`	Merchant Store URL / site URL	string	NO

Body Params

Sent by Deliverect as a JSON payload.

status

string

enum

required

The store's onboarding status:

register — A new store/location needs to establish a connection between Deliverect and a channel platform
active — A new store/location is ready to start receiving orders into Deliverect from the channel platform
inactive — A customer wants to stop receiving orders to this store/location from the channel platform

Allowed:

channelLocationId

string

required

An identifier which can be set in Deliverect, which is known to the Merchant and allows mapping to the corresponding Deliverect channel link

channelLinkId

string

required

The channelLinkId is the unique store identifier in Deliverect for a specific channel in a location

locationId

string

required

LocationId is the unique identifier of the location in Deliverect.

channelLinkName

string

required

The channel name displayed in Deliverect.

Headers

User-Agent

string

Defaults to Deliverect/{version}

Deliverect/{version}

X-Server-Authorization-HMAC-SHA256

string

Defaults to {signature}

{signature}

Responses

Purpose

Response Body

200

400400