Get started
Webhooks

itinerary.waypoint

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.

Event typeWhat happened
itinerary.waypoint.createdA waypoint was added to an itinerary.
itinerary.waypoint.updatedA waypoint changed.
itinerary.waypoint.deletedA waypoint was removed from an itinerary.

The ItineraryWaypointEventObject 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.

object

string

required

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.

id

string (uuid)

required

Identifier of the waypoint.

itinerary_id

string (uuid)

required

Identifier of the itinerary the waypoint belongs to.

name

string | null

required

The waypoint's name, null on one that carries none.

mode

string

required

One of: poi, point

What kind of waypoint it is.

itinerary_version

integer (int64)

required

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_at

string (date-time)

required

When the waypoint was created.

itinerary.waypoint.created

A waypoint was added.

Triggered by

Payload

type

string

required

One of: itinerary.waypoint.created

Always itinerary.waypoint.created.

data.object

ItineraryWaypointEventObject

required

The itinerary waypoint.

See the ItineraryWaypointEventObject object.

Every other field is the envelope every webhook event shares.

itinerary.waypoint.updated

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

type

string

required

One of: itinerary.waypoint.updated

Always itinerary.waypoint.updated.

data.object

ItineraryWaypointEventObject

required

The itinerary waypoint.

See the ItineraryWaypointEventObject object.

data.previous_attributes

object

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.

itinerary.waypoint.deleted

A waypoint was removed.

Triggered by

Payload

type

string

required

One of: itinerary.waypoint.deleted

Always itinerary.waypoint.deleted.

data.object

ItineraryWaypointEventObject

required

The itinerary waypoint.

See the ItineraryWaypointEventObject object.

Every other field is the envelope every webhook event shares.