Skip to content

fix: Added explicit Enum description for etaDirection field on Hello … #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andrew-stirling wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: Added explicit Enum description for etaDirection field on Hello … #116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/Webhooks/Hello order.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" }` |
Expand All @@ -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.
:::
:::
4 changes: 2 additions & 2 deletions docs/Webhooks/Tempo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"`<br/>`"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"`<br/>`"lessThan"` |
| `etaDirection` | The direction of estimation – whether the device is more than or less than the number of seconds provided. | String (Enum) | `"greaterThan"`<br/>`"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"`<br/>`"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"` |
Expand All @@ -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.
:::
:::