Events
The ten event types, and where they come from.
| Event | Univooz sends it when |
|---|---|
order.created | Somebody creates an order |
order.assigned | The fleet selects a courier |
order.accepted | The courier accepts |
order.arrived_for_pickup | The courier is at the collection point |
order.picked_up | The courier has the goods |
order.arrived_for_delivery | The courier is at the delivery point |
order.delivered | The delivery is complete |
order.cancelled | You or the fleet cancels |
order.updated | You change an order. One event for each change. |
webhook.test | You push Send test in the dashboard. It has no order. |
Events come from all sources
Each event above occurs for all sources: this API, the dashboard, and the courier's application.
An operator who types an order into the dashboard sends you the same order.created event
as POST /v1/orders. If you compare with your own database, expect orders that you did not
create.
Select the events you want
An endpoint can name the events it wants. Univooz does not send the others.
A new endpoint names none, and this means all of them.
webhook.test always arrives. You cannot remove it, because it is the answer to a button.
Ignore an event type that you do not know. Univooz adds new types without notice, and a new type is not a breaking change. A receiver that fails on an unknown type will stop on a day when you installed nothing.
What is not an event
A failed attempt by a courier is not an event. The status does not change, the courier
tries again, and the result is order.delivered or order.cancelled.