Skip to main content

Webhooks

order_unassigned

This event is triggered every time an order is unassigned from an agent.

Specific Data for this message

JSON FieldTypeDescription
order_uuidstringThe UUID of the order
partners_unique_internal_order_idstringThe order's unique ID on your system. This can be set when creating orders.
account_uuidstringThe UUID of the store
agent_uuidstringThe UUID of the driver
agent_partners_external_identifierstringThe driver's unique ID on your system. This can be set when creating a driver.
agent_partner_datahashThe driver's data on your system.
order_account_partners_external_identifierstringThe store's unique ID on your system. This can be set when setting up a store.
order_account_business_partners_external_identifierstringThe business's unique ID on your system. This can be set when setting up a business.
order_custom_fieldshash or nullIf you passed through a hash of custom fields to the order creation API (custom_fields), this will then be passed back to you here.
published_atinteger, unix timestampThe time the event occurred

Example Webhook Payload

{
"data": {
"order_uuid": "1bbccbfff496",
"partners_unique_internal_order_id": "ac730930-a545-4a54-8ad9-5f60737d8a1c",
"account_uuid": "1234c9999f79",
"agent_uuid": "1133bb999a45",
"agent_partners_external_identifier": "webhook-driver-1-partners-external-identifier",
"agent_partner_data": {},
"partners_unique_internal_order_id": "bb61f5f3-af81-4fa1-9281-32f7e8b2d0ed",
"order_account_partners_external_identifier": "partners-external-identifier-account",
"order_account_business_partners_external_identifier": "",
"order_custom_fields": null,
"published_at": 1651156220.3478127
},
"environment": "production",
"event_name": "order_unassigned",
"created_at": "2022-04-28T14:30:20.483+00:00",
"event_uuid": "b3df4834-328b-4d54-a871-91b17aa52ca4",
"metadata": {
"sent_at": "2022-04-28T14:30:20.500+00:00",
"delivery_attempt": 1
}
}