Get started
Webhooks

organization

organization

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

Event typeWhat happened
organization.createdAn organization was created.
organization.updatedAn organization's name changed.

The OrganizationEventObject object

An organization as a webhook event carries it: its identifier, its name and its version. getOrganization reads the rest.

object

string

required

One of: organization

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

id

string (uuid)

required

Identifier of the organization.

name

string

required

The organization's name.

version

integer (int64)

required

The organization's version once this change was made. It climbs with every change a read of the organization shows, so of two events about one organization the one carrying the higher version is the later state: events are not delivered in order.

created_at

string (date-time)

required

When the organization was created.

updated_at

string (date-time)

required

When the organization's own fields last changed.

organization.created

An organization was created, with the user who created it as its owner.

Triggered by

  • organization.create: Always.
    • POST /v1/organizations: postOrganization, mountaya.admin.organizations.postOrganization() in TypeScript. Every organization created.
    • Mountaya's web application: An organization created signed in to Mountaya's web application.

Payload

type

string

required

One of: organization.created

Always organization.created.

data.object

OrganizationEventObject

required

Every other field is the envelope every webhook event shares.

organization.updated

An organization's own fields were changed, which is its name.

Triggered by

  • organization.update: When the name changes. A request naming the name the organization already holds writes nothing and records nothing.
    • PATCH /v1/organizations/{organization_id}: patchOrganization, mountaya.admin.organizations.patchOrganization() in TypeScript. Every change accepted.

Payload

type

string

required

One of: organization.updated

Always organization.updated.

data.object

OrganizationEventObject

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.