Webhook events
Every webhook event type, when it fires and the permission it needs.
Every event a webhook endpoint can subscribe to. How delivery, signing and retries work: Webhooks guide.
| Event | When it fires | Needs |
|---|---|---|
trip.created |
A trip was created. | trips:read |
trip.updated |
A trip's fields or metadata changed. changed names the fields. |
trips:read |
trip.archived |
A trip was archived. data is null: an archived trip is not readable (see GET /trips/archived). |
trips:read |
trip.restored |
An archived trip was restored. | trips:read |
trip.published |
A trip was published to its travelers. | trips:read |
trip.unpublished |
A trip was unpublished. | trips:read |
trip.deleted |
A trip was erased for good. data is null. |
trips:read |
trip.itinerary.updated |
A trip's itinerary changed — one event per burst of edits. data is the TRIP; read the tree with GET /trips/{tripId}/itinerary. |
trips:read |
quote.created |
A quote was created. | quotes:read |
quote.updated |
A quote changed. changed names the fields. |
quotes:read |
quote.sent |
A quote was sent (or sent again). | quotes:read |
quote.accepted |
A quote was accepted. | quotes:read |
quote.rejected |
A quote was rejected. | quotes:read |
quote.deleted |
A quote was deleted. data is null. |
quotes:read |
traveler.added |
A passenger was added to a trip. Personal data. | travelers:read |
traveler.updated |
A passenger changed. changed names the fields. Personal data. |
travelers:read |
traveler.removed |
A passenger was removed. data is null. |
travelers:read |
trip.contact.updated |
A trip's booking contact was made, changed or removed (data null when there is none). Personal data. |
travelers:read |
document.created |
A document finished uploading. | documents:read |
document.updated |
A document was renamed, moved or released. changed names the fields. |
documents:read |
document.deleted |
A document was deleted. data is null. |
documents:read |