itinerary
Subscribe an endpoint to every event on this page with itinerary.*. Each is the envelope every webhook event shares, with the ItineraryEventObject object as its data.object.
An itinerary as a webhook event carries it: its identifiers, its name and description, its status, whether it is private, and its version. Its segments, waypoints and geometry are never carried: getItinerary reads them.
objectstring
One of: itinerary
The kind of object this is, always itinerary: the family of the event types that carry it, and what tells the members of WebhookEventObject apart.
idstring (uuid)
Identifier of the itinerary.
organization_idstring (uuid)
Identifier of the organization the itinerary belongs to.
activity_idstring (uuid)
Identifier of the itinerary's activity, in the catalog getActivities lists.
namestring
The itinerary's name.
descriptionstring | null
The itinerary's description, null when it has none.
statusstring
One of: draft, published
Whether the itinerary has a live publication once this change was made.
is_privateboolean
Whether the itinerary is private to the organization.
versioninteger (int64)
The itinerary's version once this change was made. It climbs with every change a read of the itinerary shows, so of two events about one itinerary the one carrying the higher version is the later state: events are not delivered in order. A delete is the itinerary's last version change: itinerary.deleted carries the version one past the last the itinerary held, so an event about it that arrives after its delete is never the later state.
originstring
One of: created, imported, duplicated
How the itinerary came to be. Present on itinerary.created alone.
created_byobject
The user who created the itinerary.
created_atstring (date-time)
When the itinerary was created.
updated_atstring (date-time)
When the itinerary last changed.
An itinerary was created, imported from a file or copied. origin says which.
Triggered by
itinerary.create: Always, withorigincreated.POST /v1/itineraries:postItinerary,mountaya.studio.itineraries.postItinerary()in TypeScript. Every itinerary created.
itinerary.import: Always, withoriginimported. Its segments and waypoints are part of it, and record no event of their own.POST /v1/itineraries/import:postItineraryImport,mountaya.studio.itineraries.postItineraryImport()in TypeScript. Every import confirmed.
itinerary.duplicate: Always, for the copy, withoriginduplicated. The itinerary copied is not changed.POST /v1/itineraries/{itinerary_id}/duplicate:postItineraryDuplicate,mountaya.studio.itineraries.postItineraryDuplicate()in TypeScript. Every copy made.
Payload
typestring
One of: itinerary.created
Always itinerary.created.
data.objectItineraryEventObject
The itinerary.
Every other field is the envelope every webhook event shares.
An itinerary's own fields were written. A change to its segments, segment groups or waypoints is an event of their own.
Triggered by
itinerary.update: Always: every accepted change writes a new revision, one that sends the values already held included.PATCH /v1/itineraries/{itinerary_id}:patchItinerary,mountaya.studio.itineraries.patchItinerary()in TypeScript. Every change accepted.
Payload
typestring
One of: itinerary.updated
Always itinerary.updated.
data.objectItineraryEventObject
The itinerary.
data.previous_attributesobject
The former value of each field of data.object the change moved, and of no other.
Every other field is the envelope every webhook event shares.
An itinerary was deleted, with its segments, segment groups, waypoints, publication and share link, which record no event of their own.
Triggered by
itinerary.delete: Always.DELETE /v1/itineraries/{itinerary_id}:deleteItinerary,mountaya.studio.itineraries.deleteItinerary()in TypeScript. Every itinerary deleted.
Payload
typestring
One of: itinerary.deleted
Always itinerary.deleted.
data.objectItineraryEventObject
The itinerary.
Every other field is the envelope every webhook event shares.
An itinerary was published: a first publication, or a republication replacing the live one.
Triggered by
itinerary.publish: Always: a republication replaces the live publication and is recorded too.POST /v1/itineraries/{itinerary_id}/publication:postItineraryPublication,mountaya.studio.itineraries.postItineraryPublication()in TypeScript. Every publication.
Payload
typestring
One of: itinerary.published
Always itinerary.published.
data.objectItineraryEventObject
The itinerary.
Every other field is the envelope every webhook event shares.
An itinerary's live publication was taken down.
Triggered by
itinerary.unpublish: When the itinerary was published. Taking down what is not published records nothing.DELETE /v1/itineraries/{itinerary_id}/publication:deleteItineraryPublication,mountaya.studio.itineraries.deleteItineraryPublication()in TypeScript. Every request.
Payload
typestring
One of: itinerary.unpublished
Always itinerary.unpublished.
data.objectItineraryEventObject
The itinerary.
Every other field is the envelope every webhook event shares.