Get started
Webhooks

itinerary.segment

itinerary.segment

Subscribe an endpoint to every event on this page with itinerary.segment.*. Each is the envelope every webhook event shares, with the ItinerarySegmentEventObject object as its data.object.

Event typeWhat happened
itinerary.segment.createdA segment was added to an itinerary.
itinerary.segment.updatedA segment changed.
itinerary.segment.deletedA segment was removed from an itinerary.
itinerary.segment.mergedA segment absorbed the one after it.
itinerary.segment.splitA segment was cut in two.
itinerary.segment.convertedA segment's mode changed.

The ItinerarySegmentEventObject object

A segment as a webhook event carries it: its identifiers, its name and how it is drawn. Its geometry and figures are never carried, and neither is its place in the chain: an insert, a removal at the head, a merge or a split renumbers the segments after it, which record no event of their own. getItinerary reads the whole chain.

object

string

required

One of: itinerary.segment

The kind of object this is, always itinerary.segment: the family of the event types that carry it, and what tells the members of WebhookEventObject apart.

id

string (uuid)

required

Identifier of the segment.

itinerary_id

string (uuid)

required

Identifier of the itinerary the segment belongs to.

name

string

required

The segment's name.

mode

string

required

One of: directions, linestring

How the segment is drawn once this change was made.

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 segment was created.

itinerary.segment.created

A segment was appended or inserted, or made by a split as its second half.

Triggered by

  • itinerary.segment.create: Always. The new segment starts where the last one ends, which is not changed.
    • POST /v1/itineraries/{itinerary_id}/segments: postItinerarySegment, mountaya.studio.itineraries.postItinerarySegment() in TypeScript. A request that names no before_segment_id.
  • itinerary.segment.insert: Always.
    • POST /v1/itineraries/{itinerary_id}/segments: postItinerarySegment, mountaya.studio.itineraries.postItinerarySegment() in TypeScript. A request that names a before_segment_id.
  • itinerary.segment.split: Always, for the second half.
    • POST /v1/itineraries/{itinerary_id}/segments/{segment_id}/split: postItinerarySegmentSplit, mountaya.studio.itineraries.postItinerarySegmentSplit() in TypeScript. Every split.

Payload

type

string

required

One of: itinerary.segment.created

Always itinerary.segment.created.

data.object

ItinerarySegmentEventObject

required

The itinerary segment.

See the ItinerarySegmentEventObject object.

Every other field is the envelope every webhook event shares.

itinerary.segment.updated

A segment was changed, or re-routed to meet a neighbour whose shared point a change moved.

Triggered by

  • itinerary.segment.insert: For each neighbour re-routed to meet the new segment, at most two.
    • POST /v1/itineraries/{itinerary_id}/segments: postItinerarySegment, mountaya.studio.itineraries.postItinerarySegment() in TypeScript. A request that names a before_segment_id.
  • itinerary.segment.update: Always for the segment, whose every accepted change writes a new revision, one that sends the values already held included, and for each neighbour re-routed because a new geometry moved the point they share.
    • PATCH /v1/itineraries/{itinerary_id}/segments/{segment_id}: patchItinerarySegment, mountaya.studio.itineraries.patchItinerarySegment() in TypeScript. Every change accepted.

Payload

type

string

required

One of: itinerary.segment.updated

Always itinerary.segment.updated.

data.object

ItinerarySegmentEventObject

required

The itinerary segment.

See the ItinerarySegmentEventObject 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.segment.deleted

A segment was removed, or absorbed by the segment before it in a merge.

Triggered by

Payload

type

string

required

One of: itinerary.segment.deleted

Always itinerary.segment.deleted.

data.object

ItinerarySegmentEventObject

required

The itinerary segment.

See the ItinerarySegmentEventObject object.

Every other field is the envelope every webhook event shares.

itinerary.segment.merged

A segment was merged with the one after it and now runs over both. The one absorbed records itinerary.segment.deleted.

Triggered by

Payload

type

string

required

One of: itinerary.segment.merged

Always itinerary.segment.merged.

data.object

ItinerarySegmentEventObject

required

The itinerary segment.

See the ItinerarySegmentEventObject object.

Every other field is the envelope every webhook event shares.

itinerary.segment.split

A segment was cut in two and is now the first half. The second half records itinerary.segment.created.

Triggered by

  • itinerary.segment.split: Always, for the segment cut, which is the first half.
    • POST /v1/itineraries/{itinerary_id}/segments/{segment_id}/split: postItinerarySegmentSplit, mountaya.studio.itineraries.postItinerarySegmentSplit() in TypeScript. Every split.

Payload

type

string

required

One of: itinerary.segment.split

Always itinerary.segment.split.

data.object

ItinerarySegmentEventObject

required

The itinerary segment.

See the ItinerarySegmentEventObject object.

Every other field is the envelope every webhook event shares.

itinerary.segment.converted

A segment was converted between routed and freehand.

Triggered by

  • itinerary.segment.convert: When the mode changes. A segment already in the mode asked for records nothing.
    • POST /v1/itineraries/{itinerary_id}/segments/{segment_id}/convert: postItinerarySegmentConvert, mountaya.studio.itineraries.postItinerarySegmentConvert() in TypeScript. Every request.

Payload

type

string

required

One of: itinerary.segment.converted

Always itinerary.segment.converted.

data.object

ItinerarySegmentEventObject

required

The itinerary segment.

See the ItinerarySegmentEventObject 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.