Three lines

Uber

Developers

[Webhook] Driver Status Change

Privileged and Confidential This endpoint design has been confidentially shared with you. It is still under development and is subject to change without notice. Please do not share this document or API endpoint details with anyone who is not authorized to have access. For more information read about scopes.

This webhook allows the rental company to listen to status change of the driver who has rented a vehicle from them.

More details about webhooks can be found here.

Resource

To be defined by the rental company. This also needs to be registered in developer dashboard.

HTTP Method

POST

Access Method

None. Auth process defined here.

Request Header Parameters

Defined here

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.
Example
{
    "event_id":"44761ec2-dea9-44b3-8eda-ccf22befaa35",
    "event_time":1520394983,
    "event_type":"DRIVER_STATUS_UPDATED",
    "meta":{
        "resource_id":"driver_id",
        "updated_at":1556542167
    }
}

Note - After receiving the webhook, Rental company should call 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, rental company can compare both the updated_at timestamps(present in the webhook and the one returned by the API).

Uber

Developers
© 2023 Uber Technologies Inc.