Webhooks
¶ Introduction
Webhooks are a communication standard that makes it easy to get push notifications as an event happens. Unlike APIs where you call an endpoint for data, you provide a callback URL where you will be notified as events happen. For example, when an Uber ride occurs, Uber can send information through HTTP POST to your callback URL. Your callback URL can then execute code based on the POST.
Webhooks can be sent more than once and the delivery is not guaranteed to be in order. To defend against this behavior, a resource_href is provided in the body of the POST to get the most update-to-date information on each resource.
Note: Webhook access on an organization level is only available for Uber for Business Enterprise clients. Please reach out to your account representative or contact our team to get access.
¶ Configure your Webhook
Follow the instructions in Getting Started to ensure that you have been approved for access to your organization’s data and the business.receipts
scope.
To enable webhooks, log in to the developer dashboard and go the Settings tab for your app. Under the Ride Requests section, add your webhook URL and click save.
You can enter any URL you’d like to have events sent to, but this should be a dedicated page on your server.
¶ POST Parameters
Webhooks sent from Uber’s servers will follow a standard format so that your application can easily understand what action it may want to take based on the contents of the payload. Below are the POST parameters that can be expected with each POST request received.
¶ Event Types
Once you’ve been granted access to your organization’s data, you will begin receiving webhook events for all business webhooks listed below. For all events, only trips taken on a rider’s official business profile will be sent; personal trips will not be returned.
¶ Available Webhooks
Endpoint | Description |
---|---|
business_trips.invoice_ready | Event indicating that an invoice has been created for the trip. |
business_trips.receipt_ready | Event indicating that a receipt has been created for the trip. |