How to implement the Register Webhook URL

Register POS webhook URL

The Register POS webhook url is where we send the information of a new location that needs to be registered to your POS.
You will need to create a webhook for that purpose and add it in the Deliverect account in staging.

Once your integration is live in production, we will add this URL in our backend. While in testing, this needs to be configured in the Deliverect customer account settings of your staging environment.

📘

Unique URL

The Register POS webhook URL needs to be unique for the integration. We will use the same webhook for any future location registrations.

How to Save your Register Webhook URL in staging

In order to save your register POS webhook URL, you need to go to your test account in the staging environment. Go to Locations and click on Edit.

There you can edit the field for the Register webhook URL and click on Save.

🚧

Location Id

The location id that you see in the settings refers to the "external location id" that comes from your side. This is not to be confused with the Deliverect locationId.

Using an external location id is optional.

Register Event

Once you fill in the external location id (optional) and the register POS webhook URL, you can then click on Register.

This will trigger an API call to your Register webhook URL. In this call, Deliverect will send you the following information:

{
    "accountId":"606d8489fcd8eddf5xxxxxx",
    "locationId":"606d8489fcd8eddf13xxxxx",
    "externalLocationId":"23A13DSDDXXXX",
    "locationName": "location name"
}

What we expect is that your webhook responds with the rest of the webhook URLs for that specific location. See the example below:

{
  "ordersWebhookURL": "https://integrator.com/ordersWebhookURL",
  "syncProductsURL": "https://integrator.com/syncProductsURL",
  "syncTablesURL": "https://integrator.com/syncTablesURL",
  "syncFloorsURL": "https://integrator.com/syncFloorsURL"
}

Did this page help you?