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, a unique ID known to the POS will be set in the Deliverect location settings. This is referred to as the externalLocationId Our onboarding teams will be provided with this ID, either by the customer or from the POS partner's support team.

We include this externalLocationId along with both the Deliverect accountId and locationId in the register event. This should provide all the information needed to complete the mapping between the POS and Deliverect.

Request Parameters

The webhook payload is shown as an example below, with the properties defined as follows;

{
  "accountId": "63********************a7",
  "locationId": "62********************e4",
  "externalLocationId": "61********************r5",
  "locationName": "Test Store"
}

Response Parameters

We always expect a JSON result containing the endpoints as per the example below. When returned as response, they will be automatically set in the location settings.

In response to this event, the URLs needed for the integration should be returned as in the below example. In particular, the ordersWebhookURL and syncProductsURL should be returned in order to provide the means of syncing in products and injecting orders directly into the POS.

{
  "ordersWebhookURL": "https://integrator.com/ordersWebhookURL",
  "syncProductsURL": "https://integrator.com/syncProductsURL",
  "syncTablesURL": "https://integrator.com/syncTablesURL",
  "syncFloorsURL": "https://integrator.com/syncFloorsURL",
  "operationsWebhookURL": "https://integrator.com/operationsURL",
  "storeStatusWebhookURL": "https://integrator.com/storeStatusURL",
  "taxCalculationWebhookURL": "https://integrator.com/taxCalculationURL"
}