Get started
Webhooks

organization.entitlements

organization.entitlements

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

Event typeWhat happened
organization.entitlements.updatedWhat an organization holds changed.

The OrganizationEntitlementsEventObject object

What an organization holds, as a webhook event carries it: its capabilities and the studio features its agreement grants.

object

string

required

One of: organization.entitlements

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

organization_id

string (uuid)

required

Identifier of the organization.

capabilities

array of string

required

The capabilities the organization holds once this change was made.

studio_entitlements

array of string

required

The studio features the organization's agreement grants once this change was made.

organization.entitlements.updated

The capabilities or studio features an organization holds changed: its agreement with Mountaya changed, or its Data API subscription started or ended, whoever made the change that started or ended it and whenever Mountaya recorded it.

Triggered by

  • organization.entitlements.update: When what the organization holds changes. A recomputation that finds it unchanged records nothing.
    • Mountaya's staff: Mountaya's staff record a change to the organization's agreement.
    • The payment provider: The organization's Data API subscription starts or ends.
    • A schedule: Every day, and every week, a check finds that what the organization holds differs from what its Data API subscription or its agreement grants.
    • Mountaya: A member's change to the organization's billing changes what it holds: its billing account is opened, its first payment method opens its Data API subscription, or the subscription is run again. So does Mountaya revising what a subscription grants.

Payload

type

string

required

One of: organization.entitlements.updated

Always organization.entitlements.updated.

data.object

OrganizationEntitlementsEventObject

required

The organization entitlements.

See the OrganizationEntitlementsEventObject object.

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.