Get started
Webhooks

Event types

Event types

Every webhook event type, by family. An endpoint subscribes to one type, to every type of a family with <family>.*, or to every type with *. Tasks says what records each one.

The envelope

A webhook event: a change Mountaya recorded, as it is delivered to an endpoint and listed by getOrganizationWebhookEvents. The body of a delivery is exactly this object, and its signature covers those bytes. Every public type and the lean object it carries is an entry of this document's webhooks.

id

string (uuid)

required

Identifier of the event. Its leading bits are the moment it was recorded, so identifiers sort by time. A delivery can arrive more than once, so a receiver deduplicates on it.

object

string

required

One of: webhook_event

Always webhook_event.

type

string

required

What happened. The family before its last dot names the kind of data.object.

api_version

string

required

The contract version the payload follows: the info.version of the document that describes it.

created_at

string (date-time)

required

When the change was made.

organization_id

string (uuid)

required

Identifier of the organization the change was made in.

task

string

required

The task that recorded the event: the resource's path and what was done, such as organization.member.update. The contract's tasks.yaml lists every task with what triggers it and the event types it records.

related_object

object

required

The object the event is about.

data

object

required

The object, and what the change moved.

request

WebhookEventRequest | null

required

The request that made the change, a change made signed in to Mountaya's web application or by Mountaya's staff included. Null only when Mountaya made the change on its own: a schedule, work finished after a request was answered, or the payment provider's report.

actor

object

required

Who made the change.

Every event type

organization

The organization page documents each one, and organization.* subscribes to all of them.

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

organization.member

The organization.member page documents each one, and organization.member.* subscribes to all of them.

Event typeWhat happened
organization.member.createdSomebody joined an organization.
organization.member.updatedA member's role changed.
organization.member.deletedA member left an organization or was removed from it.

organization.invitation

The organization.invitation page documents each one, and organization.invitation.* subscribes to all of them.

Event typeWhat happened
organization.invitation.createdSomebody was invited to an organization.
organization.invitation.acceptedAn invitation was accepted.
organization.invitation.declinedAn invitation was declined.
organization.invitation.revokedAn invitation was withdrawn.
organization.invitation.expiredAn invitation lapsed unanswered.
organization.invitation.deletedAn invitation was superseded.

collection

The collection page documents each one, and collection.* subscribes to all of them.

Event typeWhat happened
collection.createdA collection was created.
collection.updatedA collection's name, description or privacy changed.
collection.deletedA collection was deleted.

collection.itinerary

The collection.itinerary page documents each one, and collection.itinerary.* subscribes to all of them.

Event typeWhat happened
collection.itinerary.addedAn itinerary was added to a collection.
collection.itinerary.removedAn itinerary left a collection.
collection.itinerary.movedAn itinerary moved within a collection.

collection.zone

The collection.zone page documents each one, and collection.zone.* subscribes to all of them.

Event typeWhat happened
collection.zone.addedA zone was added to a collection.
collection.zone.removedA zone left a collection.

The collection.share_link page documents each one, and collection.share_link.* subscribes to all of them.

Event typeWhat happened
collection.share_link.createdA collection's share link was created.
collection.share_link.rotatedA collection's share link was rotated.
collection.share_link.deletedA collection's share link was removed.

itinerary

The itinerary page documents each one, and itinerary.* subscribes to all of them.

Event typeWhat happened
itinerary.createdAn itinerary was created.
itinerary.updatedAn itinerary's name, description or privacy changed.
itinerary.deletedAn itinerary was deleted.
itinerary.publishedAn itinerary was published.
itinerary.unpublishedAn itinerary was taken down.

itinerary.segment

The itinerary.segment page documents each one, and itinerary.segment.* subscribes to all of them.

Event typeWhat happened
itinerary.segment.createdA segment was added to an itinerary.
itinerary.segment.updatedA segment changed.
itinerary.segment.deletedA segment was removed from an itinerary.
itinerary.segment.mergedA segment absorbed the one after it.
itinerary.segment.splitA segment was cut in two.
itinerary.segment.convertedA segment's mode changed.

itinerary.segment_group

The itinerary.segment_group page documents each one, and itinerary.segment_group.* subscribes to all of them.

Event typeWhat happened
itinerary.segment_group.createdA segment group was created.
itinerary.segment_group.updatedA segment group changed.
itinerary.segment_group.deletedA segment group was dissolved.

itinerary.waypoint

The itinerary.waypoint page documents each one, and itinerary.waypoint.* subscribes to all of them.

Event typeWhat happened
itinerary.waypoint.createdA waypoint was added to an itinerary.
itinerary.waypoint.updatedA waypoint changed.
itinerary.waypoint.deletedA waypoint was removed from an itinerary.

The itinerary.share_link page documents each one, and itinerary.share_link.* subscribes to all of them.

Event typeWhat happened
itinerary.share_link.createdAn itinerary's share link was created.
itinerary.share_link.rotatedAn itinerary's share link was rotated.
itinerary.share_link.deletedAn itinerary's share link was removed.

zone

The zone page documents each one, and zone.* subscribes to all of them.

Event typeWhat happened
zone.createdA zone was created.
zone.updatedA zone changed.
zone.deletedA zone was deleted.
zone.publishedA zone was published.
zone.unpublishedA zone was taken down.

organization.publishable_key

The organization.publishable_key page documents each one, and organization.publishable_key.* subscribes to all of them.

Event typeWhat happened
organization.publishable_key.createdA publishable key was created.
organization.publishable_key.updatedA publishable key's name or scopes changed.
organization.publishable_key.revokedA publishable key was revoked.

organization.secret_key

The organization.secret_key page documents each one, and organization.secret_key.* subscribes to all of them.

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.

organization.ai_provider_config

The organization.ai_provider_config page documents each one, and organization.ai_provider_config.* subscribes to all of them.

Event typeWhat happened
organization.ai_provider_config.createdAn AI provider was configured.
organization.ai_provider_config.updatedAn AI provider configuration changed.
organization.ai_provider_config.deletedAn AI provider configuration was deleted.

organization.settings

The organization.settings page documents each one, and organization.settings.* subscribes to all of them.

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

organization.entitlements

The organization.entitlements page documents each one, and organization.entitlements.* subscribes to all of them.

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

organization.billing.subscription

The organization.billing.subscription page documents each one, and organization.billing.subscription.* subscribes to all of them.

Event typeWhat happened
organization.billing.subscription.createdA Data API subscription was opened.
organization.billing.subscription.updatedA Data API subscription changed.
organization.billing.subscription.pausedA Data API subscription was paused.
organization.billing.subscription.resumedA Data API subscription was resumed.
organization.billing.subscription.canceledA Data API subscription ended.

organization.billing.invoice

The organization.billing.invoice page documents each one, and organization.billing.invoice.* subscribes to all of them.

Event typeWhat happened
organization.billing.invoice.paidAn invoice was paid.
organization.billing.invoice.payment_failedAn invoice's payment failed.
organization.billing.invoice.payment_action_requiredAn invoice's payment needs the payer's action.

organization.billing.payment_method

The organization.billing.payment_method page documents each one, and organization.billing.payment_method.* subscribes to all of them.

Event typeWhat happened
organization.billing.payment_method.attachedA payment method was saved.
organization.billing.payment_method.updatedA payment method became, or stopped being, the default.
organization.billing.payment_method.detachedA payment method was removed.

organization.billing.info

The organization.billing.info page documents each one, and organization.billing.info.* subscribes to all of them.

Event typeWhat happened
organization.billing.info.updatedAn organization's billing information changed.

organization.webhook_endpoint

The organization.webhook_endpoint page documents each one, and organization.webhook_endpoint.* subscribes to all of them.

Event typeWhat happened
organization.webhook_endpoint.createdA webhook endpoint was created.
organization.webhook_endpoint.updatedA webhook endpoint changed.
organization.webhook_endpoint.deletedA webhook endpoint was deleted.
organization.webhook_endpoint.enabledA webhook endpoint was enabled.
organization.webhook_endpoint.disabledA webhook endpoint was disabled.
organization.webhook_endpoint.failingA webhook endpoint has failed for 24 hours.
organization.webhook_endpoint.recoveredA webhook endpoint reported failing succeeded again.
organization.webhook_endpoint.secret_rotatedA webhook endpoint's secret was rotated.