From a2c5d9899e24864422e4495df66f351255680dc8 Mon Sep 17 00:00:00 2001 From: Andrew Stirling Date: Thu, 17 Jul 2025 17:07:58 +1000 Subject: [PATCH] fix: Added explicit Enum description for etaDirection field on Hello and Tempo webhooks --- docs/Webhooks/Hello order.md | 4 ++-- docs/Webhooks/Tempo.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/Webhooks/Hello order.md b/docs/Webhooks/Hello order.md index f5f30a3e..98dac8bf 100644 --- a/docs/Webhooks/Hello order.md +++ b/docs/Webhooks/Hello order.md @@ -93,7 +93,7 @@ Hello Order Webhook body field description | `customerName` | String | The name of the customer who made the order | `"John Smith"` | | `orderId` | String | The identifier of the order | `"Order 1234"` | | `eta` | Number | The estimated time of arrival of the user to the store in seconds. | `300` | -| `etaDirection` | String | The direction of estimation – whether the device is more than or less than the number of seconds provided. | - `"greaterThan"` - `"lessThan"` | +| `etaDirection` | String (Enum) | The direction of estimation – whether the device is more than or less than the number of seconds provided. | - `"greaterThan"` - `"lessThan"` | | `status` | String | The status of the order | `"Arrived"` | | `stateDisplayName` | String | The display name of the order status on Hello Screens | `"On The Way"` | | `hsFields` | JSON Object | Key/Value pairs passed from the application to Bluedot Point SDK. This will not be returned as part of the request if no data set on the Mobile SDK. | `{ "key1": "value1" }` | @@ -114,4 +114,4 @@ Hello Order Webhook body field description This documentation describes the latest webhook version (2.1) which includes destination custom data. Previous versions are still available and fully supported to ensure backward compatibility with existing integrations. -::: \ No newline at end of file +::: diff --git a/docs/Webhooks/Tempo.md b/docs/Webhooks/Tempo.md index 31de75d6..e54c6711 100644 --- a/docs/Webhooks/Tempo.md +++ b/docs/Webhooks/Tempo.md @@ -152,7 +152,7 @@ Tempo Webhook Field description | `destination.customData` | Custom data related to the destination. | JSON | `{ "StoreType": "Flagship", "OpenHours": "9AM-5PM" }` | | `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 | `300` | -| `etaDirection` | The direction of estimation – whether the device is more than or less than the number of seconds provided. | String | `"greaterThan"`
`"lessThan"` | +| `etaDirection` | The direction of estimation – whether the device is more than or less than the number of seconds provided. | String (Enum) | `"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"` | @@ -171,4 +171,4 @@ Tempo Webhook Field description :::info **Note on Webhook Versioning** Tempo webhooks now include destination custom data in the payload, providing more contextual information about the destination. This enhancement allows you to access destination-specific information directly in your webhook handlers. -::: \ No newline at end of file +:::