Merge pull request #127 from Bluedot-Innovation/feat/update-docs-with-core-and-geotrigger-webhook-changes

feat: Webhook 2.2, API version restructure

Author: ryancrummy-rezolve

docs/APIs/Orders API/Getting started.md

@@ -15,26 +15,26 @@ The Orders API uses API Key-based authentication to secure your requests. Here's
     - Navigate to the **Canvas** dashboard.
     - Go to the **API Management** section and create an API Key for the Orders API (Admin permissions required).
     - Save the API Key securely; you'll need it for all requests.
-    
+
     For more details about managing API keys, see the [API Keys documentation](../../Canvas/API%20Keys%20management.md).
-    
+
 2. **Include the API Key in Requests:**
     - Add the API Key to the **`x-bluedot-api-key`** header of your requests:
-        
+
         ```makefile
         "x-bluedot-api-key": <your_api_key>
         ```
-        
+
 3. **Revoking API Keys:**
     - If an API Key is compromised or no longer needed, you can revoke it in the Canvas. Deleted keys will no longer grant access.
 
 ### **Base URLs**
 
 The Orders API provides region-specific endpoints to optimise performance and comply with regional regulations. Use the URL that matches your account's region:
 
-- **US Region: `https://us1-orders.bluedot.io`**
-- **EU Region: `https://eu1-orders.bluedot.io`**
-- **APAC Region: `https://au1-orders.bluedot.io`**
+- **US Region: `https://us1-orders-core.bluedot.io`**
+- **EU Region: `https://eu1-orders-core.bluedot.io`**
+- **APAC Region: `https://au1-orders-core.bluedot.io`**
 
 Make sure you’re using the correct URL for your region to avoid errors.
 
@@ -50,8 +50,8 @@ Example:
 
 ```
 POST /orders
-Host: us1-orders.bluedot.io
+Host: us1-orders-core.bluedot.io
 Authorization: Bearer <your_api_key>
 Content-Type: application/json
 Accept: application/json
-```
+```

docs/APIs/Orders API/Key concepts.md

@@ -1,24 +1,24 @@
 Key concepts
 ============
 
-To get the most out of the Orders API, it’s important to understand the core ideas behind its design. This section covers the fundamental workflows and error-handling mechanisms that will help you 
+To get the most out of the Orders API, it’s important to understand the core ideas behind its design. This section covers the fundamental workflows and error-handling mechanisms that will help you
 effectively integrate the API.
 
 ### **When to Use the Orders API**
 
 The Orders API is ideal in the following scenarios:
 
 - **Standalone Use:**
-    
+
     Use the Orders API by itself when you need to manage orders without relying on real-time geolocation or the Point SDK. For example:
-    
+
     - Cancel incomplete orders after 24 hours.
     - Update order details (e.g., delivery address or special instructions) directly from a server-side system.
     - Listen to ETA updates from third-party delivery partners and use the **`updateOrder`** event type to reflect these changes in Hello Screens.
 - **Combined with Point SDK:**
-    
+
     Use the Orders API alongside the Point SDK to enrich location-based updates with additional order details. For example:
-    
+
     - Register orders with the Orders API, passing the generated **`userToken`** and order ID as metadata in the Point SDK custom event. This enables automatic updates for ETA and arrival detection in Hello Screens.
     - Use the **`updateOrder`** event type to add or change details, such as when a customer provides additional information (e.g., car color or pickup bay number).
 
@@ -29,17 +29,17 @@ The Orders API is ideal in the following scenarios:
 Orders in Hello Screens follow a clear lifecycle that the API reflects:
 
 1. **Order Creation:**
-    
+
     Submit a new order using the **`Create Order`** endpoint. This sets the order's initial state.
-    
+
 2. **Order Updates:**
-    
+
     Modify an existing order’s details (e.g., status, delivery information, customer details) using the **`updateOrder`** event type.
-    
+
 3. **Order Cancellation:**
-    
+
     Cancel orders when necessary using the **`cancelled`** event type.
-    
+
 
 ---
 
@@ -81,11 +81,11 @@ The Orders API supports two ways to include additional information in an event p
 #### **1. `hsFields`**
 
 - **Purpose:**
-    
+
     Use **`hsFields`** to provide details that need to be displayed to store staff through Hello Screens. This information is typically operational and helps the team process the order efficiently.
-    
+
     These fields are visible in the **order modal** or **order details** screens used by the store.
-    
+
 - **Example Use Cases:**
     - Displaying a customer's car model, color, and plate number for curbside pickup.
     - Showing the parking bay number where a customer is waiting.
@@ -94,11 +94,11 @@ The Orders API supports two ways to include additional information in an event p
 #### **2. `customEventMetaData`**
 
 - **Purpose:**
-    
-    Use **`customEventMetaData`** to include information that is important for managing, tracking, or analysing the order but does not need to be visible to store staff or displayed in Hello Screens. 
-    
-    The list of custom data fields **won’t** be included to the API responses but will be sent via [Hello Order Webhooks](https://docs.bluedot.io/Webhooks/Hello%20order). This data remains backend-focused and is primarily for use in your internal systems or analytics tools. 
-    
+
+    Use **`customEventMetaData`** to include information that is important for managing, tracking, or analysing the order but does not need to be visible to store staff or displayed in Hello Screens.
+
+    The list of custom data fields **won't** be included to the API responses but will be sent via [Hello Order Webhooks](https://docs.bluedot.io/Webhooks/Hello-order). This data remains backend-focused and is primarily for use in your internal systems or analytics tools.
+
 - **Example Use Cases:**
     - Tracking partner delivery IDs for system integrations.
     - Including an internal reference ID for analytics purposes.
@@ -113,7 +113,7 @@ Order IDs are essential part of managing orders with Orders API. While they’re
 
 1. **24 Hours Behaviour:**  By default, an `orderId` can’t be reused or registered again within 24 hours for the same store and project. The countdown resets each time an event is recorded for the order (e.g., an update or status change).
 2. **Updating Orders:** If the details of an order change (e.g., delivery address or items), use the `updateOrder` event Type to modify the existing order.
-3. **Overwriting Orders:** If you need to reuse an existing `orderId` within the 24-hour period, you can set the `forceOverwrite` property to `true` when submitting a new order. This replaces the current order associated with the same `orderId`. 
+3. **Overwriting Orders:** If you need to reuse an existing `orderId` within the 24-hour period, you can set the `forceOverwrite` property to `true` when submitting a new order. This replaces the current order associated with the same `orderId`.
 
 While this can be helpful in certain situations, we recommend using it only when necessary. Overwriting orders too frequently impacts order tracking data and analytics consistency. Use a unique `orderId` for each store and project combo whenever possible.
 
@@ -126,4 +126,4 @@ While this can be helpful in certain situations, we recommend using it only when
 		"errorDescription": "Order already exists with that orderId in the target destination. Either use PUT to update the order or set forceOverwrite to true to overwrite the existing order with a new one."
 	}
 }
-```
+```

docs/Canvas/Overview.md

@@ -14,7 +14,7 @@ _Learn about using_ [_Canvas_](https://select-region.bluedot.io/) _to operate yo
 
 Rezolve Canvas is a feature-rich user interface for you to operate and configure your Rezolve account. You can use Canvas to build Projects, create Zones, draw Geofences, manage your account and more.
 
-Once you’ve integrated the SDK in your mobile app, you can use Canvas (or our Config. API) to design valuable, real-world experiences for your app users.
+Once you've integrated the SDK in your mobile app, you can use Canvas (or our Config API) to design valuable, real-world experiences for your app users.
 
 We’re always happy to help with integration, Zone setup or other questions you might have – just contact our Support Team.
 
@@ -41,4 +41,4 @@ Next steps
 Read on to learn more about Canvas and Rezolve:
 
 *   [Creating a new Project](../Canvas/Creating%20a%20new%20project.md)
-*   [Creating a new Zone](../Canvas/Add%20a%20new%20zone.md)
+*   [Creating a new Zone](../Canvas/Add%20a%20new%20zone.md)

docs/Custom Data.md

@@ -39,7 +39,7 @@ eventMetaData.put("key2", "value2");
 ServiceManager.getInstance(context).setCustomEventMetaData(eventMetaData);
 ```
 
-Detailed informaion the `setCustomEventMetaData` API can be found in the [Android SDK documentation](https://android-docs.bluedot.io/-bluedot%20-s-d-k%20-docs/au.com.bluedot.point.net.engine/-service-manager/set-custom-event-meta-data.html).
+Detailed information the `setCustomEventMetaData` API can be found in the [Android SDK documentation](https://android-docs.bluedot.io/-bluedot%20-s-d-k%20-docs/au.com.bluedot.point.net.engine/-service-manager/set-custom-event-meta-data.html).
 
 #### iOS
 ```swift
@@ -55,7 +55,7 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau
 }
 ```
 
-Detailed informaion the `setCustomEventMetaData` API can be found in the [iOS SDK documentation](https://ios-docs.bluedot.io/Classes/BDLocationManager.html#/c:objc(cs)BDLocationManager(im)setCustomEventMetaData:).
+Detailed information the `setCustomEventMetaData` API can be found in the [iOS SDK documentation](https://ios-docs.bluedot.io/Classes/BDLocationManager.html#/c:objc(cs)BDLocationManager(im)setCustomEventMetaData:).
 
 :::info
 The custom event metadata is not persisted across SDK sessions. If the SDK is logged out the custom event metadata is cleared by the SDK. The Custom Event Metadata can be set at any time, although we suggest setting the custom data before starting GeoTriggering or Tempo.
@@ -93,7 +93,7 @@ Zone Custom Data is used to attach specific information to geographical zones, t
 ### Implementation
 You could also use Config API to set Zone Custom Data. For more details please refer to [Config API documentation](https://config-docs.bluedot.io/#tag/zones/operation/addZone).
 
-#### Example 
+#### Example
 ```json
 {
     "zone_id": "zone123",
@@ -129,4 +129,4 @@ You could also use Config API to set Zone Custom Data. For more details please r
     }
   }
 }
-```
+```

docs/Point SDK/Overview.mdx

@@ -8,44 +8,69 @@ import Card from '../../src/components/Card'
 Overview
 ========
 
-Welcome to Rezolve's Point SDK documentation! Our SDK integrates with both native and cross-platform frameworks, empowering your app with precise, efficient location services. Let's start enhancing your application.
+Welcome to Rezolve's Point SDK documentation! Our SDK integrates with both native and cross-platform frameworks, empowering your app with precise, efficient location services.
 
+## What is Point SDK?
+
+Point SDK is Rezolve's mobile location intelligence engine that brings high-accuracy geofencing and ETA prediction capabilities to your iOS and Android applications. With minimal battery impact and offline capability, Point SDK enables you to create sophisticated location-based experiences.
+
+## Key Capabilities
+
+### Geo-triggering
+Trigger actions when users enter or exit geofenced areas with 20x more accuracy than standard geofencing solutions. Perfect for:
+- Store arrival notifications
+- Proximity marketing campaigns
+- Location-based content delivery
+- Customer journey tracking
+
+### Tempo (ETA Predictions)
+Get real-time customer arrival estimates as they travel to your locations. Ideal for:
+- Curbside pickup optimization
+- Drive-thru order timing
+- Delivery coordination
+- Staff preparation alerts
+
+### Low Battery Impact
+Advanced algorithms ensure minimal battery drain while maintaining precision location tracking, even when your app is in the background.
+
+### Offline Capability
+Geofences work even without network connectivity - triggers fire locally on the device.
 
 <div className="card-stack-two-column">
-<Card 
+<Card
     title="Android"
     description=""
     link="/Point%20SDK/Android/Overview"
     icon="img/icons/Android-SDK.png"
 />
-<Card 
+<Card
     title="iOS"
     description=""
     link="/Point%20SDK/iOS/Overview"
     icon="img/icons/iOS-SDK.png"
 />
-<Card 
+<Card
     title="React Native"
     description=""
     link="/Point%20SDK/React%20Native/Overview"
     icon="img/icons/React-Native.png"
 />
-<Card 
+<Card
     title="Flutter"
     description=""
     link="/Point%20SDK/Flutter/Overview"
     icon="img/icons/Flutter.png"
 />
-<Card 
+<Card
     title="Xamarin"
     description=""
     link="/Point%20SDK/Xamarin/Overview"
     icon="img/icons/Xamarin.png"
 />
-<Card 
+<Card
     title="Cordova"
     description=""
     link="/Point%20SDK/Cordova/Overview"
     icon="img/icons/Cordova.png"
 />
-</div>
+</div>

docs/Regions URLs.md

@@ -16,7 +16,7 @@ Choose the endpoint that corresponds to the region where your account is hosted.
 | Config API    | https://config.bluedot.io/prod1    | https://eu1-config.bluedot.io/prod1    | https://us1-config.bluedot.io/prod1    |
 | Analytics API | https://analytics.bluedot.io/prod1 | https://eu1-analytics.bluedot.io/prod1 | https://us1-analytics.bluedot.io/prod1 |
 | Events API    | https://au1-events.bluedot.io/     | https://eu1-events.bluedot.io/         | https://us1-events.bluedot.io/         |
-| Orders API    | https://au1-orders.bluedot.io      | https://eu1-orders.bluedot.io          | https://us1-orders.bluedot.io          |
+| Orders API    | https://au1-orders-core.bluedot.io | https://eu1-orders-core.bluedot.io     | https://us1-orders-core.bluedot.io     |
 | Now Ready     | https://au.nowready.io             | https://eu.nowready.io                 | https://us.nowready.io                 |
 
-To access Canvas you can also the [Select Region](https://select-region.bluedot.io/) page and select your Account’s region.
+To access Canvas you can also the [Select Region](https://select-region.bluedot.io/) page and select your Account’s region.