Channel Registration

webhook

https://yourwebhook.com/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.

Payload

To facilitate store onboarding, Deliverect first sends a register event to initiate store mapping on the channel side, where a JSON body listing all supported webhook URLs is expected in response (see Response body). When customers are ready to launch, an active status confirms that integrations functions like ordering, menu management etc should be switched on. If a store is to be offboarded sends an inactive event is sent and all aspects of the connection should be de-integrated.

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

channelLinkId is an individual store’s unique ID in Deliverect.

locationId

string

required

locationId is Deliverect's unique identifier of a physical restaurant location, store, or kitchen.

channelLinkName

string

required

The channel name displayed in Deliverect.

Headers

User-Agent

string

required

Defaults to Deliverect/{version}

Identifies Deliverect as the sender of the webhook, in the format Deliverect/{version}.

X-Server-Authorization-HMAC-SHA256

string

required

Defaults to {signature}

HMAC-SHA256 signature of the raw request body, generated with your shared secret. Recompute the signature on receipt and compare it to this value to verify the request came from Deliverect (see the HMAC authentication guide).

Responses

Purpose

200For a register event, return the JSON object below with the correct endpoint to use for each webhook event type. Deliverect stores these automatically, so no manual configuration is needed. For active and inactive events, no response body is expected; return a 200 only.

400400