Uber Developers

Uber

Developers

[Webhook] Realtime 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 suppliers to listen to realtime status change events of the drivers in the fleet

More details about webhooks can be found here.

¶ Resource

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

¶ HTTP Method

POST

¶ Access Method

None. Auth process defined here.

¶ Request Header Parameters

Defined here

¶ Body Parameters

Name	Type	Description
`driver_id`	string	Raw unique identifier for the driver
`event_id`	string	Unique event identifier ensuring event uniqueness
`event_time`	long	Unix timestamp indicating when the status change event occurred
`event_type`	string	Specifies the type of event that occurred. In this case, it would be “REALTIME_DRIVER_STATUS_CHANGE”
`location`	object	Contains Location coordinates representing the location when the status change event occurred
`org_id`	string	Encrypted Organization ID
`status`	string	Indicates the current Status of the driver
`vehicle_id`	string	Raw unique identifier for the vehicle.
`webhook_meta`	object	Additional Meta related to the webhook
`resource_href`	string	URL pointing to the endpoint

Location

Name	Type	Description
`latitude`	float	The latitude coordinate of the location when status change event occurred.
`longitude`	float	The longitude coordinate of the location when status change event occurred.

Status

Status	Definition
`DRIVER_STATUS_ONLINE`	If the driver is online , but not on any active trip
`DRIVER_STATUS_OFFLINE`	If the driver is offline
`DRIVER_STATUS_ENROUTE`	If the driver is on the way for pickup
`DRIVER_STATUS_ONTRIP`	If the driver is on any leg of the trip

Meta

Name	Type	Description
`client_id`	string	The ID of the client associated with the webhook.
`webhook_config_id`	string	The ID of the webhook configuration.
`webhook_msg_timestamp`	long	Unix timestamp indicating when the webhook message was sent
`webhook_msg_uuid`	string	Unique identifier for the webhook message

¶ Example

{
    "driver_id": "1a8e9cf5-ee45-4c8a-a5cd-7d32c9515d72",
    "event_id": "6f0d8726-3b25-4e6e-9268-5ab6c3a78b4f",
    "event_time": 1697253089123,
    "event_type": "REALTIME_DRIVER_STATUS_CHANGE",
    "location": {
        "latitude": 38.899349,
        "longitude": -122.414592
    },
    "org_id": "9t54qzKl3pRg7UdY_O5DlLOH3t3oOcNdK3pIW1q6NiJ8KxGbsAV-C9lWtT6T1qlpGQ6SHobVJJaO2lUiBU3G5M-wOggAMz8NqToBlNQVr90uaLiDLbU9P9xAtdTFqinNw==",
    "resource_href": "https://api.uber.com/v1/vehicle-suppliers/realtime/driver/status/change",
    "status": "DRIVER_STATUS_ENROUTE",
    "vehicle_id": "c50b508a-7040-4a77-b290-8f8c2c96f43d",
    "webhook_meta": {
        "client_id": "a3ef6mCIqspWQgyFFexMVTgbRKMwNlF0",
        "webhook_config_id": "vehicle-solutions.ep-realtime-driver-status-change",
        "webhook_msg_timestamp": 1699877427,
        "webhook_msg_uuid": "670532a8-ca01-4b4f-b145-d7ca5d945448"
    }
}

Resource

HTTP Method

Access Method

Request Header Parameters

Body Parameters

Example

Uber

Developers