itinerary.share_link
Subscribe an endpoint to every event on this page with itinerary.share_link.*. Each is the envelope every webhook event shares, with the ItineraryShareLinkEventObject object as its data.object.
An itinerary's share link as a webhook event carries it: the itinerary it opens and when its token was minted. The token itself is never carried: getItineraryShareLink reads it.
objectstring
One of: itinerary.share_link
The kind of object this is, always itinerary.share_link: the family of the event types that carry it, and what tells the members of WebhookEventObject apart.
itinerary_idstring (uuid)
Identifier of the itinerary the link opens.
created_atstring (date-time)
When the link's token was minted: when the link was created, or last rotated.
An itinerary's share link was minted, the first time it was asked for.
Triggered by
itinerary.share_link.create: When the link is minted. Returning the link the itinerary already has records nothing.POST /v1/itineraries/{itinerary_id}/share-link:postItineraryShareLink,mountaya.studio.itineraries.postItineraryShareLink()in TypeScript. Every request.
Payload
typestring
One of: itinerary.share_link.created
Always itinerary.share_link.created.
data.objectItineraryShareLinkEventObject
The itinerary share link.
Every other field is the envelope every webhook event shares.
An itinerary's share link was given a new token, which disables the old one.
Triggered by
itinerary.share_link.rotate: Always.POST /v1/itineraries/{itinerary_id}/share-link/rotate:postItineraryShareLinkRotate,mountaya.studio.itineraries.postItineraryShareLinkRotate()in TypeScript. Every rotation.
Payload
typestring
One of: itinerary.share_link.rotated
Always itinerary.share_link.rotated.
data.objectItineraryShareLinkEventObject
The itinerary share link.
Every other field is the envelope every webhook event shares.
An itinerary's share link was removed, which disables its token.
Triggered by
itinerary.share_link.delete: When the itinerary had a link. Removing one that is not there records nothing.DELETE /v1/itineraries/{itinerary_id}/share-link:deleteItineraryShareLink,mountaya.studio.itineraries.deleteItineraryShareLink()in TypeScript. Every request.
Payload
typestring
One of: itinerary.share_link.deleted
Always itinerary.share_link.deleted.
data.objectItineraryShareLinkEventObject
The itinerary share link.
Every other field is the envelope every webhook event shares.