itinerary.waypoint
Subscribe an endpoint to every event on this page with itinerary.waypoint.*. Each is the envelope every webhook event shares, with the ItineraryWaypointEventObject object as its data.object.
A waypoint as a webhook event carries it: its identifiers, its name and its mode. Its location and content are never carried: getItinerary reads them.
objectstring
One of: itinerary.waypoint
The kind of object this is, always itinerary.waypoint: the family of the event types that carry it, and what tells the members of WebhookEventObject apart.
idstring (uuid)
Identifier of the waypoint.
itinerary_idstring (uuid)
Identifier of the itinerary the waypoint belongs to.
namestring | null
The waypoint's name, null on one that carries none.
modestring
One of: poi, point
What kind of waypoint it is.
itinerary_versioninteger (int64)
The itinerary's version once this change was made, which every change to its segments, segment groups and waypoints moves. Of two events about one itinerary, the one carrying the higher figure is the later state.
created_atstring (date-time)
When the waypoint was created.
A waypoint was added.
Triggered by
itinerary.waypoint.create: Always.POST /v1/itineraries/{itinerary_id}/waypoints:postItineraryWaypoint,mountaya.studio.itineraries.postItineraryWaypoint()in TypeScript. Every waypoint added.
Payload
typestring
One of: itinerary.waypoint.created
Always itinerary.waypoint.created.
data.objectItineraryWaypointEventObject
The itinerary waypoint.
Every other field is the envelope every webhook event shares.
A waypoint was changed.
Triggered by
itinerary.waypoint.update: Always: every accepted change writes a new revision, one that sends the values already held included.PATCH /v1/itineraries/{itinerary_id}/waypoints/{waypoint_id}:patchItineraryWaypoint,mountaya.studio.itineraries.patchItineraryWaypoint()in TypeScript. Every change accepted.
Payload
typestring
One of: itinerary.waypoint.updated
Always itinerary.waypoint.updated.
data.objectItineraryWaypointEventObject
The itinerary waypoint.
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.
A waypoint was removed.
Triggered by
itinerary.waypoint.delete: Always.DELETE /v1/itineraries/{itinerary_id}/waypoints/{waypoint_id}:deleteItineraryWaypoint,mountaya.studio.itineraries.deleteItineraryWaypoint()in TypeScript. Every waypoint removed.
Payload
typestring
One of: itinerary.waypoint.deleted
Always itinerary.waypoint.deleted.
data.objectItineraryWaypointEventObject
The itinerary waypoint.
Every other field is the envelope every webhook event shares.