Webhooks

 

Register Webhooks to receive real-time notifications from your app user’s activity. Webhooks can be used to send events for:

  • Geo-trigger: Entry and/or exit into a Zone/Geofence
  • Tempo: ETA calculations as a user moves towards a Zone
  • Wave: API responses when a user notifies of their arrival

Configure a Webhook

There are two ways to configure a Webhook:

  • Through the Canvas UI
  • Config API (Information on using the Config API for registering a Webhook can be found here.)

Webhooks are configured at the Project level with a maximum of one webhook for each Event type.

To set up webhooks, login to Canvas and head to the Webhooks section.

1. Under your Account, choose Webhooks

2. Click on the Add Webhook button and enter the webhook details

URL The URL of the server where the webhooks will be received. We suggest that the service has SSL enabled.
Token key (optional) To provide additional security, we prefer to send a key-value pair as part of the request header. The Token Key is the name of the field to be sent in the POST request header.
Example: “authToken” or “apiKey”
Token value (optional) The Token Value field carries the security token sent in the POST request header.
Example: “f2f7a58c-f0d5-498c-9bad-acbc89923dc5” or “e4d2697bc8cc4df98ab6a88f0fd56ec3”

Receiving a Webhook notification

To receive a webhook, you would need a server that can accept and process POST requests.

Webhook response header structure

The Token Key and Token Value will be sent as part of the HTTP header. The server should be able to authenticate the header of the request.

tokenKey: "tokenValue"

We encourage you to make use of these Key/Value tokens to sign the events with our own values to verify the origin of the events.

Example HTTP header in the request

{
    "securitytoken": "72340732BlueDOT7297329-T0",
    "contenttype": "application/json"
}

Webhook response JSON structure

Created by Bluedot DevOps on January 11, 2018

Start the discussion