Skip to content

Conversation

@ryancrummy-rezolve
Copy link

Update Docs: Webhook V2.2 (Dwell), Point SDK Overview, and API Version Restructure

This PR introduces the documentation for Geo-triggering Webhooks V2.2, which adds support for Dwell events. It also restructures how webhook versions are organised, revamps the Point SDK Overview page, updates Orders API endpoints, and cleans up project dependencies.

Key Changes

🪝 Webhooks V2.2 & Dwell Events

  • Updated Geo-triggering.md: Now reflects Version 2.2 as the latest standard.
  • Added documentation for Dwell Events (triggers based on time spent in a zone).
  • Added new payload fields: dwellThreshold, calculatedDwellTime, and crossedFences (tracking fences crossed during a dwell).
  • Updated the JSON payload example to show a Dwell event structure.

📂 Documentation Restructuring

  • New Versions Directory: Created versions directory to archive older specifications.
  • Legacy Files Moved/Created:
    • Moved V1 (V1/Geo-triggering.md) and V2 (V2/Geo-triggering.md) to the new versions folder.
    • Created Geo-triggering-v2-1.md to preserve the previous "current" state (Entry/Exit with destination data).
  • Navigation & Alerts: Added :::info and :::warning callouts on legacy pages to direct users to the latest documentation.
  • Renaming: Renamed Hello%20order.md to Hello-order.md for URL consistency.

📱 Point SDK Overview

  • Content: Update docs/Point SDK/Overview.mdx to provide better context.
  • Added specific sections for "Key Capabilities" (Geo-triggering, Tempo, Low Battery, Offline).

🔗 API Endpoints

  • Orders API: Updated base URLs across documentation (Getting started.md, Regions URLs.md) to reflect the new Core endpoints:
    us1-orders.bluedot.ious1-orders-core.bluedot.io
    (Applied to EU and APAC regions as well).

📦 Project Configuration

  • Dependency Management: Removed package-lock.json as the repository uses Yarn for dependency management and conflicts with yarn.lock.

🛠️ Minor Fixes

  • Typos: Fixed "informaion" typos in Custom Data.md.
  • Links: Corrected internal linking in Orders API/Key concepts.md and Canvas/Overview.md.

…ave webhooks

- Introduced Geo-triggering Webhook V2.0 and V2.1 documentation with detailed payload structures and examples.
- Added Hello Order Webhook V1.0 documentation outlining the JSON request structure and field descriptions.
- Created Tempo Webhook V1.0 documentation including update and stop request structures.
- Added Wave Webhook V1.0 documentation with request structures and field descriptions.
- Updated sidebar navigation to include new versions and reorganized previous versions under a single category.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants