Uber Developers

Uber

Developers

[Webhook] Document 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.

¶ Use case

By subscribing to this webhook, rental companies will receive notifications whenever there is a change in the status of any associated document. This functionality ensures that companies can manage their documentation efficiently and stay updated on the compliance and availability of vehicle-related documents.

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.

¶ 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.
`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, it’s vehicle_id.

¶ 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":"VEHICLE_DOCUMENT_STATUS_UPDATED",
    "meta":{
        "resource_id":"vehicle_id"
    }
}

¶ 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.