[Webhook] Driver Status Change
¶ UseCase
A rental company receives a notification via the [Webhook] Driver Status Change when a driver’s status updates to “ACTIVE, APPLIED, WAITLISTED, REJECTED etc” due to a compliance issue. Along with the Get Compliance Info API, companies can identify problems, such as expired licenses. They promptly inform the driver, providing instructions for license renewal to ensure compliance and prevent service interruptions, thereby maintaining fleet efficiency and safety standards.
For more information on how to utilize webhooks, please refer to the provided link here.
¶ Supported supplier types
Rentals
¶ Support for Hierarchical Data
The webhook supports hierarchical data, sending updates for all organizations under the root where the clientID is allowlisted. This ensures comprehensive data coverage and management across different levels of the organization.
¶ Webhook response fields
¶ Request Query/Body Parameters
| Name | Type | Description |
|---|---|---|
event_id |
string | Unique event identifier, which can be used to ensure that events are only digested once. This is a Uber generated UUID. |
event_time |
long | Unix timestamp of the time the event occurred. |
event_type |
string | The type of event that occurred. In this case, value would be DRIVER_STATUS_UPDATED. |
meta |
object | The object containing additional information that is specific to the event_type. |
¶ Request Query/Body Parameters - Meta
| Name | Type | Description |
|---|---|---|
resource_id |
String | Unique identifier of the resource this event has been generated for, in this case driver_id. |
updated_at |
Long | Epoch timestamp representing when the driver status was last modified. |
¶ Webhook Security
For detailed information on securing webhooks, please refer to the security guidelines here.
¶ Webhook event structure
{
"event_id":"44761ec2-dea9-44b3-8eda-ccf22befaa35",
"event_time":1520394983,
"event_type":"DRIVER_STATUS_UPDATED",
"meta":{
"resource_id":"driver_id",
"updated_at":1556542167
}
}
¶ Retry
If Uber does not receive an acknowledgement response, the event will be resent based on an exponential backoff algorithm. The next webhook event will be sent 30 seconds after the initial event, then again after 60 seconds, then after 120 seconds, and so on. Seven retries will be made with this exponential backoff.
¶ Backfill Process
Currently not supported.
¶ Sand Box
Please note that sandbox support is currently unavailable.
¶ Notes
- After receiving the webhook, the Rental company should call the Get Compliance Info API to retrieve the driver’s current compliance status. To ensure that the status returned by the API is the latest one, the rental company can compare the updated _at timestamps (present in the webhook and the one returned by the API). Comparing these timestamps helps verify that the information from the API is up-to-date and reflects any recent changes, ensuring accurate and reliable compliance status.