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.
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.
idstring (uuid)
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.
objectstring
One of: webhook_event
Always webhook_event.
typestring
What happened. The family before its last dot names the kind of data.object.
api_versionstring
The contract version the payload follows: the info.version of the document that describes it.
created_atstring (date-time)
When the change was made.
organization_idstring (uuid)
Identifier of the organization the change was made in.
taskstring
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_objectobject
The object the event is about.
dataobject
The object, and what the change moved.
requestWebhookEventRequest | null
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.
actorobject
Who made the change.
The organization page documents each one, and organization.* subscribes to all of them.
The organization.member page documents each one, and organization.member.* subscribes to all of them.
The organization.invitation page documents each one, and organization.invitation.* subscribes to all of them.
The collection page documents each one, and collection.* subscribes to all of them.
The collection.itinerary page documents each one, and collection.itinerary.* subscribes to all of them.
The collection.zone page documents each one, and collection.zone.* subscribes to all of them.
The collection.share_link page documents each one, and collection.share_link.* subscribes to all of them.
The itinerary page documents each one, and itinerary.* subscribes to all of them.
The itinerary.segment page documents each one, and itinerary.segment.* subscribes to all of them.
The itinerary.segment_group page documents each one, and itinerary.segment_group.* subscribes to all of them.
The itinerary.waypoint page documents each one, and itinerary.waypoint.* subscribes to all of them.
The itinerary.share_link page documents each one, and itinerary.share_link.* subscribes to all of them.
The zone page documents each one, and zone.* subscribes to all of them.
The organization.publishable_key page documents each one, and organization.publishable_key.* subscribes to all of them.
The organization.secret_key page documents each one, and organization.secret_key.* subscribes to all of them.
The organization.ai_provider_config page documents each one, and organization.ai_provider_config.* subscribes to all of them.
The organization.settings page documents each one, and organization.settings.* subscribes to all of them.
The organization.entitlements page documents each one, and organization.entitlements.* subscribes to all of them.
The organization.billing.subscription page documents each one, and organization.billing.subscription.* subscribes to all of them.
The organization.billing.invoice page documents each one, and organization.billing.invoice.* subscribes to all of them.
The organization.billing.payment_method page documents each one, and organization.billing.payment_method.* subscribes to all of them.
The organization.billing.info page documents each one, and organization.billing.info.* subscribes to all of them.
The organization.webhook_endpoint page documents each one, and organization.webhook_endpoint.* subscribes to all of them.