Webhook Events
This section describes all available webhook events that can be configured to notify external systems about various activities in the platform. Webhook events allow external systems to receive real-time notifications about important activities, facilitating seamless integration with third-party services such as CRM systems, inventory management, mapping services, and more.
When creating a webhook, you can subscribe to any combination of these events based on your specific needs. This allows you to customize your webhook to only receive notifications for the events that matter most to your application.
You can add Webhook endpoints from developers section of the dashboard. 🔗 https://dashboard.lynxo.ai/developers
Job Events
Job events provide real-time notifications about delivery order lifecycle management, enabling external systems to stay synchronized with order status and progress.
| Event Name | Description |
|---|---|
| job.created | Notify external systems about new delivery orders, sync with inventory systems |
| job.updated | Real-time tracking updates, status synchronization with external systems |
| job.deleted | Clean up external system records, maintain audit trails |
| job.pickup.updated | Track pickup progress, notify warehouses about pickup status |
| job.delivery.updated | Track delivery progress, notify customers about delivery status, update inventory |
For job.pickup.updated and job.delivery.updated events, you can identify the specific pickup or delivery task that was modified by checking the data_id field within the webhook payload's data object. This unique identifier helps track which particular task was affected by the update.
Customer Events
Customer events ensure that customer data remains consistent across all integrated systems, providing seamless customer experience management.
| Event Name | Description |
|---|---|
| customer.created | Sync customer data with CRM systems, create customer profiles in external systems |
| customer.updated | Keep external systems updated with customer information changes |
Address Events
Address events help maintain accurate location data across mapping services and delivery systems, ensuring optimal route planning and delivery zone management.
| Event Name | Description |
|---|---|
| address.created | Sync address data with mapping services, update delivery zones |
| address.updated | Update mapping services, recalculate delivery routes |
| address.deleted | Clean up external system records, update delivery zones |