collection
Subscribe an endpoint to every event on this page with collection.*. Each is the envelope every webhook event shares, with the CollectionEventObject object as its data.object.
A collection as a webhook event carries it: its identifiers, its name and description, whether it is private, and its version. getCollection reads the itineraries and zones it holds.
objectstring
One of: collection
The kind of object this is, always collection: the family of the event types that carry it, and what tells the members of WebhookEventObject apart.
idstring (uuid)
Identifier of the collection.
organization_idstring (uuid)
Identifier of the organization the collection belongs to.
namestring
The collection's name.
descriptionstring | null
The collection's description, null when it has none.
is_privateboolean
Whether the collection is private to the organization.
versioninteger (int64)
The collection's version once this change was made. It climbs with every change a read of the collection shows, so of two events about one collection the one carrying the higher version is the later state: events are not delivered in order. A delete is the collection's last version change: collection.deleted carries the version one past the last the collection held, so an event about it that arrives after its delete is never the later state.
created_byobject
The user who created the collection.
created_atstring (date-time)
When the collection was created.
updated_atstring (date-time)
When the collection last changed.
A collection was created.
Triggered by
collection.create: Always.POST /v1/collections:postCollection,mountaya.studio.collections.postCollection()in TypeScript. Every collection created.
Payload
typestring
One of: collection.created
Always collection.created.
data.objectCollectionEventObject
The collection.
Every other field is the envelope every webhook event shares.
A collection's own fields were changed.
Triggered by
collection.update: When a field changes. A request sending the values the collection already holds writes nothing and records nothing.PATCH /v1/collections/{collection_id}:patchCollection,mountaya.studio.collections.patchCollection()in TypeScript. Every change accepted.
Payload
typestring
One of: collection.updated
Always collection.updated.
data.objectCollectionEventObject
The collection.
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 collection was deleted. What it held and its share link go with it, and record no event of their own.
Triggered by
collection.delete: Always. The itineraries and zones it held are not changed, and leave it without an event of their own.DELETE /v1/collections/{collection_id}:deleteCollection,mountaya.studio.collections.deleteCollection()in TypeScript. Every collection deleted.
Payload
typestring
One of: collection.deleted
Always collection.deleted.
data.objectCollectionEventObject
The collection.
Every other field is the envelope every webhook event shares.