iOS SDK 15.6.7,
Android SDK 15.5.3,
Hello Screen Dynamic States,
Bluedot Cordova plugin 4.0.1,
Bluedot Xamarin Android wrapper 15.5.2,
Bluedot Xamarin iOS wrapper 15.6.6,
Bluedot React Native wrapper 2.3.0,
During API integration, there are 3 important stages that align with your customer’s experience.
Custom Event Metadata
to be attached with each Wave Event – this is usually at least the customer’s name and orderID.DestinationId
– this is where the customer is collecting their order. You can use anything, but we recommend using the normal Store Number or Restaurant ID.Wave API is hosted in multiple regions worldwide to ensure the better performance of our services. Each region is completely independent and in a separated geographic area.
If you’re not sure which region your account is in, please contact us at help@bluedot.io.
The API specification for Wave API can be found here.
To send a Wave event you’ll need to make a POST request to the Wave endpoint. It only requires to sign the request with the projectId
and include the destinationId
that it’s effectively the Zone the user has arrived.
You can also add context to the Wave Event, such as the user’s location, the event’s time, and other properties that can help you better understand your user’s behaviour.
Wave API uses the projectId
to sign requests. You’ll need to add the key x-bluedot-api-key
with the projectId
as the value in request’s headers as shown below:
"x-bluedot-api-key": "<YOUR_PROJECT_ID>"
You can find your projectId
in the Canvas in the Account section.
// JSON { "destinationId": "your_zone_destinationId" }
// JSON { "destinationId": "melbourne_store_001", "customEventMetaData": { "userId": "your_user_id", "storeId": "your_store_id" }, "location": { "longitude": 144.123123123, "latitude": -33.123123123, "horizontalAccuracy": 12.232323, "bearing": 123, "speed": 2 }, "eventTime": "2018-09-02T00:08:16.000Z" }
The Wave Events can also inform Hello Screens of the arrival of a customer to a Zone. You just need to add the OrderId
in the customEventMetaData
as shown below:
// JSON { "destinationId": "melbourne_store_001", "customEventMetaData": { "OrderId": "aslkfiowae" } }
We also recommend using the other properties the Hello Screens provides, such as adding the customer’s name and any additional relevant information for your use case. The fields that have the prefix hs_
will be displayed in the Order’s details.
// JSON { "destinationId": "melbourne_store_001", "customEventMetaData": { "OrderId": "aslkfiowae" "hs_Customer Name": "James", "hs_Car Model": "Honda Civic", "hs_Car Color": "Red", "hs_Loyalty ID": "ABC123", "hs_Mobile Number": "3231234567" } }
To update the state of order in Hello Screens with Wave API, you’ll need to include the property eventType
in the Custom Event Meta Data. There are three main values to pass in eventType
Event Type | Description |
onTheWay |
|
arrival |
|
updateOrder |
|
// JSON { "destinationId": "melbourne_store_001", "customEventMetaData": { "OrderId": "aslkfiowae" "hs_Customer Name": "James", "eventType": "onTheWay" } }