Get started
Webhooks

organization.secret_key

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.

Event typeWhat happened
organization.secret_key.createdA secret key was created.
organization.secret_key.updatedA secret key was renamed.
organization.secret_key.revokedA secret key was revoked.

The SecretKeyEventObject 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.

object

string

required

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.

id

string (uuid)

required

Identifier of the key.

organization_id

string (uuid)

required

Identifier of the organization the key belongs to.

name

string

required

The key's name.

suffix

string

required

The last four characters of the key's value.

created_at

string (date-time)

required

When the key was created.

revoked_at

string (date-time)

When the key was revoked. Present once it is.

organization.secret_key.created

A secret key was created, signed in to Mountaya's web application.

Triggered by

Payload

type

string

required

One of: organization.secret_key.created

Always organization.secret_key.created.

data.object

SecretKeyEventObject

required

Every other field is the envelope every webhook event shares.

organization.secret_key.updated

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

type

string

required

One of: organization.secret_key.updated

Always organization.secret_key.updated.

data.object

SecretKeyEventObject

required
data.previous_attributes

object

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.

organization.secret_key.revoked

A secret key was revoked, signed in to Mountaya's web application.

Triggered by

Payload

type

string

required

One of: organization.secret_key.revoked

Always organization.secret_key.revoked.

data.object

SecretKeyEventObject

required

Every other field is the envelope every webhook event shares.