Receipt Ready Notification
WEBHOOK: POSThttps://<YOUR_WEBHOOK_URI> event_type: health.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.
¶ 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 health.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": "health.receipt_ready",
"meta": {
"user_id": "d13dff8b-das-asd-1212e",
"org_uuid": "43142cf0-073f-4542-81e2-c3cf520fccea",
"resource_id": "5152dcc5-b88d-4754-8b33-975f4067c943",
"status": "ready"
},
"resource_href": "https://api.uber.com/v1/health/trips/5152dcc5-b88d-4754-8b33-975f4067c943/receipt"
}