Get started
Webhooks

collection.share_link

collection.share_link

Subscribe an endpoint to every event on this page with collection.share_link.*. Each is the envelope every webhook event shares, with the CollectionShareLinkEventObject object as its data.object.

Event typeWhat happened
collection.share_link.createdA collection's share link was created.
collection.share_link.rotatedA collection's share link was rotated.
collection.share_link.deletedA collection's share link was removed.

A collection's share link as a webhook event carries it: the collection it opens and when its token was minted. The token itself is never carried: getCollectionShareLink reads it.

object

string

required

One of: collection.share_link

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

collection_id

string (uuid)

required

Identifier of the collection the link opens.

created_at

string (date-time)

required

When the link's token was minted: when the link was created, or last rotated.

A collection's share link was minted, the first time it was asked for.

Triggered by

  • collection.share_link.create: When the link is minted. Returning the link the collection already has records nothing.
    • POST /v1/collections/{collection_id}/share-link: postCollectionShareLink, mountaya.studio.collections.postCollectionShareLink() in TypeScript. Every request.

Payload

type

string

required

One of: collection.share_link.created

Always collection.share_link.created.

data.object

CollectionShareLinkEventObject

required

The collection share link.

See the CollectionShareLinkEventObject object.

Every other field is the envelope every webhook event shares.

A collection's share link was given a new token, which disables the old one.

Triggered by

Payload

type

string

required

One of: collection.share_link.rotated

Always collection.share_link.rotated.

data.object

CollectionShareLinkEventObject

required

The collection share link.

See the CollectionShareLinkEventObject object.

Every other field is the envelope every webhook event shares.

A collection's share link was removed, which disables its token.

Triggered by

  • collection.share_link.delete: When the collection had a link. Removing one that is not there records nothing.
    • DELETE /v1/collections/{collection_id}/share-link: deleteCollectionShareLink, mountaya.studio.collections.deleteCollectionShareLink() in TypeScript. Every request.

Payload

type

string

required

One of: collection.share_link.deleted

Always collection.share_link.deleted.

data.object

CollectionShareLinkEventObject

required

The collection share link.

See the CollectionShareLinkEventObject object.

Every other field is the envelope every webhook event shares.