Get started
Webhooks

itinerary.segment_group

itinerary.segment_group

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

Event typeWhat happened
itinerary.segment_group.createdA segment group was created.
itinerary.segment_group.updatedA segment group changed.
itinerary.segment_group.deletedA segment group was dissolved.

The ItinerarySegmentGroupEventObject object

A segment group as a webhook event carries it: its identifiers, its name and its colour. Which segments it holds is not carried: getItinerary reads it.

object

string

required

One of: itinerary.segment_group

The kind of object this is, always itinerary.segment_group: 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 group.

itinerary_id

string (uuid)

required

Identifier of the itinerary the group belongs to.

name

string

required

The segment group's name.

color

string

required

The group's colour, six lowercase hexadecimal digits after #.

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

itinerary.segment_group.created

A segment group was created.

Triggered by

Payload

type

string

required

One of: itinerary.segment_group.created

Always itinerary.segment_group.created.

data.object

ItinerarySegmentGroupEventObject

required

The itinerary segment group.

See the ItinerarySegmentGroupEventObject object.

Every other field is the envelope every webhook event shares.

itinerary.segment_group.updated

A segment group's name, colour, speed or segments changed.

Triggered by

  • itinerary.segment_group.update: When the group keeps at least two segments: every accepted change writes a new revision of it, one that sends the values already held included.
    • PATCH /v1/itineraries/{itinerary_id}/segment-groups/{group_id}: patchItinerarySegmentGroup, mountaya.studio.itineraries.patchItinerarySegmentGroup() in TypeScript. Every change accepted.

Payload

type

string

required

One of: itinerary.segment_group.updated

Always itinerary.segment_group.updated.

data.object

ItinerarySegmentGroupEventObject

required

The itinerary segment group.

See the ItinerarySegmentGroupEventObject 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_group.deleted

A segment group was deleted, or dissolved because a change left it fewer than two segments. Its segments are kept.

Triggered by

  • itinerary.segment.insert: For each group of the itinerary the change leaves fewer than two segments, which dissolves it. The change takes no segment out of a group, so this is only ever a group that already held fewer than 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: For each group of the itinerary the change leaves fewer than two segments, which dissolves it. The change takes no segment out of a group, so this is only ever a group that already held fewer than two.
    • PATCH /v1/itineraries/{itinerary_id}/segments/{segment_id}: patchItinerarySegment, mountaya.studio.itineraries.patchItinerarySegment() in TypeScript. Every change accepted.
  • itinerary.segment.delete: When the segment's group is left fewer than two segments, which dissolves it.
    • DELETE /v1/itineraries/{itinerary_id}/segments/{segment_id}: deleteItinerarySegment, mountaya.studio.itineraries.deleteItinerarySegment() in TypeScript. Every segment removed.
  • itinerary.segment.merge: When the merge leaves a group fewer than two segments, which dissolves it.
    • POST /v1/itineraries/{itinerary_id}/segments/{segment_id}/merge: postItinerarySegmentMerge, mountaya.studio.itineraries.postItinerarySegmentMerge() in TypeScript. Every merge.
  • itinerary.segment.split: For each group of the itinerary the change leaves fewer than two segments, which dissolves it. The change takes no segment out of a group, so this is only ever a group that already held fewer than two.
    • POST /v1/itineraries/{itinerary_id}/segments/{segment_id}/split: postItinerarySegmentSplit, mountaya.studio.itineraries.postItinerarySegmentSplit() in TypeScript. Every split.
  • itinerary.segment.convert: For each group of the itinerary the change leaves fewer than two segments, which dissolves it. The change takes no segment out of a group, so this is only ever a group that already held fewer than two.
    • POST /v1/itineraries/{itinerary_id}/segments/{segment_id}/convert: postItinerarySegmentConvert, mountaya.studio.itineraries.postItinerarySegmentConvert() in TypeScript. Every request.
  • itinerary.segment_group.create: For each group of the itinerary the change leaves fewer than two segments, which dissolves it. The change takes no segment out of a group, so this is only ever a group that already held fewer than two.
    • POST /v1/itineraries/{itinerary_id}/segment-groups: postItinerarySegmentGroup, mountaya.studio.itineraries.postItinerarySegmentGroup() in TypeScript. Every group created.
  • itinerary.segment_group.update: For each group of the itinerary the change leaves fewer than two segments, which dissolves it: the group itself when the change takes segments out of it, and any other group that already held fewer than two.
    • PATCH /v1/itineraries/{itinerary_id}/segment-groups/{group_id}: patchItinerarySegmentGroup, mountaya.studio.itineraries.patchItinerarySegmentGroup() in TypeScript. Every change accepted.
  • itinerary.segment_group.delete: Always. Its segments are kept, ungrouped, and record no event of their own.
    • DELETE /v1/itineraries/{itinerary_id}/segment-groups/{group_id}: deleteItinerarySegmentGroup, mountaya.studio.itineraries.deleteItinerarySegmentGroup() in TypeScript. Every group deleted.

Payload

type

string

required

One of: itinerary.segment_group.deleted

Always itinerary.segment_group.deleted.

data.object

ItinerarySegmentGroupEventObject

required

The itinerary segment group.

See the ItinerarySegmentGroupEventObject object.

Every other field is the envelope every webhook event shares.