Trip Message Notification
WEBHOOK: POSThttps://<YOUR_WEBHOOK_URI> event_type: health.trip_message
Event indicating that the driver for the trip has sent a message. The message is included under the data.message
field.
¶ 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. |
data.sender |
string |
The sender of the message. |
data.message |
string |
The message that was sent. |
The health.trip_message
event_type can only have one value at this time for meta.status
property, indicating that the driver has sent a message.
Status | Description |
---|---|
message_received | The driver has sent a message. |
¶ Example Webhook
{
"event_id": "3a3f3da4-14ac-4056-bbf2-d0b9cdcb1000",
"event_time": 1427343999,
"event_type": "health.trip_message",
"meta": {
"user_id": "d13dff8b-das-asd-1212e",
"org_uuid": "43142cf0-073f-4542-81e2-c3cf520fccea",
"resource_id": "5152dcc5-b88d-4754-8b33-975f4067c943",
"status": "message_received"
},
"data": {
"sender": "driver",
"message": "I have arrived"
},
"resource_href": "https://api.uber.com/v1/health/trips/5152dcc5-b88d-4754-8b33-975f4067c943"
}