1. Developer Documentation
  2. Tempo: Integration & User Guide
  3. Configure a Tempo Webhook

Configure a Tempo Webhook

Register Tempo Webhooks to receive real-time ETA notifications from your customers. As your customers get closer to their Destination to collect their order, Bluedot will send a notification every minute to so your team is ready to go.

Configure a Tempo Webhook

1. Under Your Account, choose Tempo Configuration

2. Add 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”

3. Save

You can also configure a Tempo Webhook through Config API (Information on using the Config API for registering a Webhook can be found here.)

Endpoint
Description
Add Tempo Webhooks to a Project
When creating or editing a Project you can add Tempo Webhooks within the tempo property.
Endpoint: https://config.bluedot.io/prod1/projects
Example of adding a Tempo Webhook:
"tempo": { 
    "webhooks": [{ 
        "type": "tempo", 
        "url": "<webhook URL goes here>" 
    }] 
}

 

Webhook response JSON structure

Update JSON response
 
{
    "deviceType": "iPhone12,3",
    "os": "iOS",
    "osVersion": "7.0",
    "customerApplicationId": "au.com.bluedot", 
    "sdkVersion": "1.11.0",
    "appBuildVersion": "1.11.2",
    "customEventMetaData": {
        "key1": "value1",
        "key2": "value2"
    },
    "eventTime": “2020-05-21T05:44:04Z",
    "longitude": 144.123123123,
    "latitude": -33.123123123,
    "destinationId": "store ID",
    "eventType": "tempoUpdate",
    "eta": 900, 
    "etaDirection": "greaterThan",
    "installRef": "1111111-2222-3333-4444-555555555555",
    "projectId": "1111111-2222-3333-4444-555555555555",
    "triggerChainId": "11111111-2222-3333-4444-555555555555",
    "notificationType": "tempo"
}
Stop JSON response
 
{
    "deviceType": "iPhone12,3",
    "os": "iOS",
    "osVersion": "7.0",
    "customerApplicationId": “au.com.bluedot", 
    "sdkVersion": "1.11.0",
    "appBuildVersion": "1.11.2",
    "customEventMetaData": {
        "key1": "value1",
        "key2": "value2"
    },
    "eventTime": "2020-05-21T05:44:04Z",
    "destinationId": "store ID",
    "stopReason": "stoppedByCustomerApp", 
    "eventType": "tempoStop",
    "installRef": "1111111-2222-3333-4444-555555555555",
    "projectId": "1111111-2222-3333-4444-555555555555",
    "triggerChainId": "11111111-2222-3333-4444-555555555555",
    "notificationType": "tempo"
}

Tempo Webhook Field description

Field name
Description
Data type
Example
appBuildVersion
The app build version of the application using the Point SDK which triggered the check-in.
String
  • 1.11.2
  • 12.0.0.1233
customerApplicationId
The application’s package name. 
String
  • au.com.bluedot
customEventMetaData
Key/Value pairs passed from the application to Bluedot Point SDK. This will not be returned as part of the response if no data set on the Mobile SDK.
JSON object
{
      “orderId”: “12345”
}
destinationId
The ID associated with the location setup in Canvas for the Zone
String
  • Store-234
deviceType
The type of device that triggered the Tempo event.
String
  • iPhone 9,3
  • samsung SM-N950F
eta
The estimated time of arrival of the user to the store in seconds.
Number
etaDirection
The direction of estimation – whether the device is more than or less than the number of seconds provided.
String
  • greaterThan
  • lessThan
eventTime
Records the time the event reaches the Bluedot platform.
String
2020-05-21T05:44:04Z
eventType
This field denotes the type of event being relayed from our servers to yours. For a stop of Tempo the type will be “tempoStop”.
String
  • tempoUpdate
  • tempoStop
installRef
A randomly issued installation reference, not tied to any personally identifiable data (PID) on the user’s device.
String
  • 44c2d0b8-0004-47fc-830d-b73e9ff706f6
latitude
Latitude component of the coordinate of the current Tempo event.
Number
  • 30.2672042
  • -37.818036
longitude
Longitude component of the coordinate the current Tempo event.
Number
  • -97.7447926
  • 144.9775493
notificationType
This field denotes the type of notification being relayed from our servers to yours. For an Tempo event  the type will be “tempo”.
String
  • tempo
os
The OS of the device that triggered the ETA event.
String
  • android
  • iOS
osVersion
The OS Version of the device that triggered the Tempo event.
String
  • 8.0.0
  • 13.1.5
projectId
The identifier of the project with which the SDK is logged into in the app.
String
  • 4647e4eb-f908-4d3d-82e9-4959d59923b0
sdkVersion
The Point SDK version number being used in the application which has triggered the Tempo event. 
String
  • 15.2.0
stopReason
This field denotes the reason for  
String
  • invalidDestinationId
  • stoppedByCustomerApp
  • arrivedAtDestination 
  • expired 
  • sdkLogout
triggerChainId
triggerChainId can be used to connect the ETA updates coming through for one set of start to finish.
String
  • c8965662-d67f-49e8-abf9-0bada6c153d1
Created by Melwin Chiramel on June 30, 2020