Get started
Webhooks

organization.settings

organization.settings

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

Event typeWhat happened
organization.settings.updatedAn organization's Map Publishing settings changed.

The OrganizationSettingsEventObject object

An organization's Map Publishing settings as a webhook event carries them: whose they are, and their version. getOrganizationSettings reads the settings themselves.

object

string

required

One of: organization.settings

The kind of object this is, always organization.settings: 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 the settings belong to.

version

integer (int64)

required

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

organization.settings.updated

An organization's Map Publishing settings were written: by a member, or by Mountaya where the organization's agreement fixes a setting.

Triggered by

  • organization.settings.update: Always: every accepted write replaces the settings and moves their version, one that sends the settings already held included.
    • PATCH /v1/organizations/{organization_id}/settings: patchOrganizationSettings, mountaya.admin.organizations.patchOrganizationSettings() in TypeScript. Every change accepted.
    • Mountaya's staff: Mountaya's staff replace the settings whole, to set a safety rule the organization's agreement fixes.

Payload

type

string

required

One of: organization.settings.updated

Always organization.settings.updated.

data.object

OrganizationSettingsEventObject

required

The organization settings.

See the OrganizationSettingsEventObject object.

Every other field is the envelope every webhook event shares.