In certain scenarios, it is more efficient to receive notifications about changes to your resources rather than making direct API calls. Webhooks provide a mechanism to track these changes in real-time.

To configure webhooks, navigate to the Apps tab under Settings , where you initially created the app for the integration. Within this section, you can manage and enable specific webhook events to be triggered. These events will automatically send notifications to the configured callbackUrl associated with the app whenever the corresponding scenarios occur.

Events

There is support for multiple events, you may choose which ones suit best for your use case.

ORDER_CREATED

Whenever an order is created, this webhook event is triggered.

ORDER_UPDATED

Whenever an order is updated, this webhook event is triggered.

ROUTE_CREATED

Whenever a route is created, this webhook event is triggered.

ROUTE_UPDATED

Whenever a route is updated, this webhook event is triggered.

ORDER_IN_TRANSIT_TO_PICKUP

When an order transitions from ASSIGNED to IN_TRANSIT_TO_PICKUP status. This indicates that the driver has initiated to travel to the pickup address. This is an explicit action that the driver marks in the mobile app.

ORDER_ARRIVED_AT_PICKUP

When an order transitions from INTRANSIT_TO_PICKUP to ARRIVED_TO_PICKUP status. This indicates that the driver has arrived near the pickup address. This is triggered automatically based on the drivers location in par with the pickup address location.

ORDER_PICKED_UP

When an order transitions from ARRIVED_TO_PICKUP to ORDER_PICKED_UPstatus. This indicates that the driver has picked up the order from the pickup address. This is an explicit action that the driver marks in the mobile app.

ORDER_IN_TRANSIT_TO_DROPOFF

Similar to the ORDER_PICKED_UP event. Triggered with the same explicit action as ORDER_PICKED_UP.

ORDER_ARRIVED_AT_DROPOFF

When an order transitions from IN_TRANSIT_TO_DROPOFFto ARRIVED_AT_DROPOFF. This indicates that the driver has arrived near the dropoff address. This is triggered automatically based on the drivers location in par with the pickup address location.

ORDER_DROPPED_OFF

When an order transitions from ARRIVED_AT_DROPOFF to DROPPED_OFF. This indicates that the driver has dropped off the order in the dropoff address. This is an explicit action that the driver marks in the mobile app.

ORDER_ASSIGNED

When the order is assigned to a driver, this event is triggered.

ORDER_UNASSIGNED

When the order is unassigned, this event is triggered.