organization.secret_key
Subscribe an endpoint to every event on this page with organization.secret_key.*. Each is the envelope every webhook event shares, with the SecretKeyEventObject object as its data.object.
A secret key as a webhook event carries it: its identifiers, its name and the last four characters of its value, which is never carried. Secret keys are made, renamed and revoked signed in to Mountaya's web application, and this contract reads none.
objectstring
One of: organization.secret_key
The kind of object this is, always organization.secret_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.
suffixstring
The last four characters of the key's value.
created_atstring (date-time)
When the key was created.
revoked_atstring (date-time)
When the key was revoked. Present once it is.
A secret key was created, signed in to Mountaya's web application.
Triggered by
organization.secret_key.create: Always.- Mountaya's web application: A secret key created signed in to Mountaya's web application.
Payload
typestring
One of: organization.secret_key.created
Always organization.secret_key.created.
data.objectSecretKeyEventObject
The secret key.
Every other field is the envelope every webhook event shares.
A secret key's name was written, signed in to Mountaya's web application.
Triggered by
organization.secret_key.update: When the name changes. Renaming a key to the name it already holds writes nothing and records nothing.- Mountaya's web application: A secret key renamed signed in to Mountaya's web application.
Payload
typestring
One of: organization.secret_key.updated
Always organization.secret_key.updated.
data.objectSecretKeyEventObject
The secret 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 secret key was revoked, signed in to Mountaya's web application.
Triggered by
organization.secret_key.revoke: When the key was in force.- Mountaya's web application: A secret key revoked signed in to Mountaya's web application.
Payload
typestring
One of: organization.secret_key.revoked
Always organization.secret_key.revoked.
data.objectSecretKeyEventObject
The secret key.
Every other field is the envelope every webhook event shares.