collection.zone
Subscribe an endpoint to every event on this page with collection.zone.*. Each is the envelope every webhook event shares, with the CollectionZoneEventObject object as its data.object.
A zone's membership of a collection: which collection and which zone.
objectstring
One of: collection.zone
The kind of object this is, always collection.zone: the family of the event types that carry it, and what tells the members of WebhookEventObject apart.
collection_idstring (uuid)
Identifier of the collection.
zone_idstring (uuid)
Identifier of the zone.
collection_versioninteger (int64)
The collection's version once this change was made, which every change to what it holds moves. Of two events about one collection, the one carrying the higher figure is the later state.
A zone the collection did not hold was added to it.
Triggered by
collection.zone.add: Once for each zone the collection did not hold.POST /v1/collections/{collection_id}/zones:postCollectionZones,mountaya.studio.collections.postCollectionZones()in TypeScript. Every request.
Payload
typestring
One of: collection.zone.added
Always collection.zone.added.
data.objectCollectionZoneEventObject
The zone of a collection.
Every other field is the envelope every webhook event shares.
A zone left a collection: it was removed from it, or the zone was deleted.
Triggered by
zone.delete: Once for each collection that held the zone.DELETE /v1/zones/{zone_id}:deleteZone,mountaya.studio.zones.deleteZone()in TypeScript. Every zone deleted.
collection.zone.remove: When the collection held the zone.DELETE /v1/collections/{collection_id}/zones/{zone_id}:deleteCollectionZone,mountaya.studio.collections.deleteCollectionZone()in TypeScript. Every request.
Payload
typestring
One of: collection.zone.removed
Always collection.zone.removed.
data.objectCollectionZoneEventObject
The zone of a collection.
Every other field is the envelope every webhook event shares.