Channel Registration

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.

Status	Event purpose
`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

🎯 Important Requirement: Standardised Register URL

The register webhook needs to be standardised i.e. the same URL should be used for every customer install.

Request

Parameter	Meaning	Type
`status`	`register` Indicates the registration of the channel. `active` Denotes the activation of the channel. `inactive` Signifies the disabling of the channel.	string
`channelLocationId`	The unique id of the Merchant in the channel platform	string
`channelLinkId`	The channel link id generated in Deliverect when it's added to the Location.	string
`locationId`	The location id generated in the Deliverect portal when it's created in Deliverect.	string
`channelLinkName`	The channel name displayed in Deliverect.	string

Examples

{
    "status": "register",
    "channelLocationId": "{{externalChannelLocationId}}",
    "channelLinkId": "{{channelLinkId}}",
    "locationId": "{{locationId}}",
    "channelLinkName": "Order Boss"
}

{
    "status": "active",
    "channelLocationId": "{{externalChannelLocationId}}",
    "channelLinkId": "{{channelLinkId}}",
    "locationId": "{{locationId}}",
    "channelLinkName": "Order Boss"
}

{
    "status": "inactive",
    "channelLocationId": "{{externalChannelLocationId}}",
    "channelLinkId": "{{channelLinkId}}",
    "locationId": "{{locationId}}",
    "channelLinkName": "Order Boss"
}

Response

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 and unsnooze 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	string	NO
`menuUrl`	Merchant Store URL / site URL	string	NO

Example

{
    "statusUpdateURL": "https://integrator.com/statusUpdate",
    "menuUpdateURL": "https://integrator.com/menuUpdate",
    "snoozeUnsnoozeURL": "https://integrator.com/snoozeUnsnooze",
    "busyModeURL": "https://integrator.com/busyMode",
    "updatePrepTimeURL": "https://integrator.com/updatePrepTimeURL",
    "paymentUpdateURL":"https://yourwebhook.com/payment_update",
  "courierUpdateURL":"https://yourwebhook.com/courier_update",
"authorizationURL":"https://yourwebhook.com/authorization",
    "menuUrl":"https://integrator.com/store"
}

ℹ️ Important Requirement: Case-Sensitive Response

Please note, the expected response is case-sensitive . Ensure the response matches the required format exactly.

Purpose

Request

Examples

Response

Example

200200

400400