organization.publishable_key
Subscribe an endpoint to every event on this page with organization.publishable_key.*. Each is the envelope every webhook event shares, with the PublishableKeyEventObject object as its data.object.
A publishable key as a webhook event carries it: its identifiers, its name, its scopes and the last four characters of its value. The value itself is never carried: getOrganizationPublishableKey reads it.
objectstring
One of: organization.publishable_key
The kind of object this is, always organization.publishable_key: the family of the event types that carry it, and what tells the members of WebhookEventObject apart.
idstring (uuid)
Identifier of the key.
organization_idstring (uuid)
Identifier of the organization the key belongs to.
namestring
The key's name.
scopesarray of string
The scopes the key carries once this change was made.
suffixstring
The last four characters of the key's value.
versioninteger (int64)
The key's version once this change was made. It climbs with every change a read of the key shows, so of two events about one key the one carrying the higher version is the later state: events are not delivered in order.
created_atstring (date-time)
When the key was created.
revoked_atstring (date-time)
When the key was revoked. Present once it is.
A publishable key was created.
Triggered by
organization.publishable_key.create: Always.POST /v1/organizations/{organization_id}/publishable-keys:postOrganizationPublishableKey,mountaya.admin.keys.postOrganizationPublishableKey()in TypeScript. Every key created.
Payload
typestring
One of: organization.publishable_key.created
Always organization.publishable_key.created.
data.objectPublishableKeyEventObject
The publishable key.
Every other field is the envelope every webhook event shares.
A publishable key's name or scopes were written.
Triggered by
organization.publishable_key.update: When the name or the scopes change. A request sending the values the key already holds writes nothing and records nothing.PATCH /v1/organizations/{organization_id}/publishable-keys/{key_id}:patchOrganizationPublishableKey,mountaya.admin.keys.patchOrganizationPublishableKey()in TypeScript. Every change accepted.
Payload
typestring
One of: organization.publishable_key.updated
Always organization.publishable_key.updated.
data.objectPublishableKeyEventObject
The publishable key.
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 publishable key was revoked.
Triggered by
organization.publishable_key.revoke: When the key was in force. Revoking a revoked key records nothing.DELETE /v1/organizations/{organization_id}/publishable-keys/{key_id}:deleteOrganizationPublishableKey,mountaya.admin.keys.deleteOrganizationPublishableKey()in TypeScript. Every request.
Payload
typestring
One of: organization.publishable_key.revoked
Always organization.publishable_key.revoked.
data.objectPublishableKeyEventObject
The publishable key.
Every other field is the envelope every webhook event shares.