Receipt Ready Notification
WEBHOOK: POSThttps://<YOUR_WEBHOOK_URI> event_type: guests.trips.receipt_ready
Event indicating that a receipt has been created for the trip. Sent upon completion of a trip or when an update to the final fare of a trip taken is added to a receipt.
¶ Retry Attempts
If for some reason the Uber API cannot reach the webhook URL you specified either due to networking issues or application issues on your end, the webhooks service will retry to make a request.
We have implemented an exponential back-off algorithm with a back-off multiplier of 30 seconds which will make up to 7 attempts. This means we will attempt to request your webhook URL up to 7 times across roughly 1 hour.
¶ Webhook Headers
The Uber API will insert specialized headers for all requests made to your webhook URL to help your application utilize them appropriately.
Header | Description |
---|---|
X-Environment |
Indicates if this request is coming from the production or sandbox API. |
X-Uber-Signature |
SHA256 hash of the request body, computed using the app’s signing key as the key. |
¶ Webhook Security
Webhook messages are signed so that your app can verify that the sender is Uber. Webhooks requests contain an X-Uber-Signature
header. The value of this field is a hexadecimal HMAC signature of the webhook HTTP request body, using signing key of primary webhook url as a key and SHA256 as the hash function.
Python Example
digester = hmac.new(signing_key, webhook_body, hashlib.sha256)
return digester.hexdigest()
¶ Webhook Event Structure
Name | Type | Description |
---|---|---|
event_id |
string |
Unique event identifier, which can be used to ensure that events are only digested once. |
event_time |
integer |
Unix timestamp of the time the event occurred. |
event_type |
string |
The type of event that occurred. |
resource_href |
string |
The URL of the resource being referenced. This URL can be called with your App’s bearer token to retrieve the full payload. |
meta |
object |
The object containing additional information that is specific to the event_type . |
meta.user_id |
string |
Unique identifier of the user this event was generated for. |
meta.org_uuid |
string |
The unique UUID of the Uber for Business organization for which the ride was requested. |
meta.resource_id |
string |
Unique identifier of the resource this event has been generated for. |
meta.status |
string |
The current status of the resource. |
The guests.trips.receipt_ready
event_type can only have one value at this time, indicating the receipt is processed and ready to be retrieved via the API.
The receipts ready webhooks are available only for production trips and are not applicable for Sandbox trips.
Status | Description |
---|---|
ready | The receipt has been generated and is ready for retrieval. |
¶ Example Webhook
{
"event_id": "3a3f3da4-14ac-4056-bbf2-d0b9cdcb1000",
"event_time": 1427343999,
"event_type": "guests.trips.receipt_ready",
"meta": {
"user_id": "d13dff8b-das-asd-1212e",
"org_uuid": "63c2fd9c-b787-47d8-ae8f-f4145cecbcb5",
"resource_id": "5152dcc5-b88d-4754-8b33-975f4067c943",
"status": "ready"
},
"resource_href": "https://api.uber.com/v1/guests/trips/5152dcc5-b88d-4754-8b33-975f4067c943/receipt"
}