Uber Developers

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.

¶ UseCase

A Supplier 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. With this webhook, 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 their efficiency and safety standards.

For more information on how to utilize webhooks, please refer to the provided link here.

¶ Supported supplier types

Fleets & 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	Required
`event_id`	string	Unique event identifier, which can be used to ensure that events are only digested once. This is a Uber generated UUID.	Yes
`event_time`	long	Unix timestamp of the time the event occurred.	Yes
`event_type`	string	The type of event that occurred. In this case, value would be DRIVER_STATUS_UPDATED.	Yes
`driver_id`	string	The driver Id for whom this change has manifested.	Yes
`organization_id`	string	The organization Id to which the Driver is linked to. Available for Fleets only.	No
`onboarding_status`	object	The object containing additional information related to compliance status.	No
`meta`	object	The object containing additional information that is specific to the event_type.	Yes

¶ Request Query/Body Parameters - Onboarding Status

Name	Type	Description	Required
`from`	object	The object containing information about the old status.	Yes
`to`	object	The object containing information about the new status.	Yes

¶ Request Query/Body Parameters - Meta

Name	Type	Description	Required
`resource_id`	String	[Deprecated] Unique identifier of the resource this event has been generated for, in this case driver_id. This field is deprecated, you can use `driver_id` field to get the same information.	Yes
`updated_at`	Long	Epoch timestamp representing when the driver status was last modified.	Yes

¶ Driver Status Flags

Status	Meaning
`ONBOARDING`	Driver is currently in the onboarding funnel and is not eligible to drive on Uber.
`ONBOARDED`	Driver is ready to drive on Uber. All the compliance and background checks are done.
`ACTIVE`	Driver is currently engaged in driving activities on the Uber platform.
`WAITLISTED`	Driver is waitlisted temporarily.
`REJECTED`	Driver is rejected from the Uber platform.

¶ 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",
    "driver_id": "encrypted_driver_id",
    "organization_id": "encrypted_organization_id",
    "onboarding_status":
    {
        "from":
        {
            "status": "ONBOARDING"
        },
        "to":
        {
            "status": "ACTIVE"
        }
    },
    "meta":{
        "resource_id":"encrypted_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.