HomeGuidesAPI DocumentationAPI UpdatesAsk a QuestionStatus Page
API Documentation

Register POS

webhook
https://yourwebhook.com/register

Purpose

When a customer is ready to integrate a location in their Deliverect account to their POS, a registration webhook event will be sent to a designated endpoint with all the information needed to establish the integration. This endpoint should be provided by the POS.

Format

Before this webhook is sent, the POS’s own identifier for the location, the externalLocationId, is set in the Deliverect location settings. Our onboarding team obtains this ID from either the customer or the POS partner’s support team.

The register event then includes the externalLocationId alongside the Deliverect accountId and locationId, providing everything needed to map the Deliverect location to the POS.

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

Payload

Sent by Deliverect as a JSON payload.

string

accountId is the unique identifier of the customer account in Deliverect

string

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

string

externalLocationId is an identifier of the location known on the POS side, it is stored within the POS config in Deliverect

string

Name of the location set in Deliverect.

Headers
string
required

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

string
required

Signature of the raw request body using your shared secret; recompute it on receipt to verify the request came from Deliverect (see HMAC authentication guide).

Response

Updated about 13 hours ago

Did this page help you?
LoadingLoading…

Updated about 13 hours ago

Did this page help you?