Tasks
A task is one change Mountaya makes, named after the resource it acts on and what it does. Every webhook event names the task that recorded it in task, and each task below lists the event types it records, with when.
Mint a session token from a secret key.
Triggered by
POST /v1/sessions:postSession,mountaya.admin.sessions.postSession()in TypeScript. Every session minted, a token returned again included.
Records no webhook event.
Start an agent run.
A run stores nothing of its own: every change it makes is a request to this API, recorded by that request's task.
Triggered by
POST /v1/agent/runs:postAgentRun,mountaya.agent.runs.postAgentRun()in TypeScript. Every run started.
Records no webhook event.
Send an input to a running agent run.
Triggered by
POST /v1/agent/runs/{run_id}/input:postAgentRunInput,mountaya.agent.runs.postAgentRunInput()in TypeScript. Every input delivered to a run.
Records no webhook event.
Rate one assistant message of an agent run.
Triggered by
POST /v1/agent/runs/{run_id}/feedback:postAgentRunFeedback,mountaya.agent.runs.postAgentRunFeedback()in TypeScript. Every rating recorded.
Records no webhook event.
Create an itinerary.
Triggered by
POST /v1/itineraries:postItinerary,mountaya.studio.itineraries.postItinerary()in TypeScript. Every itinerary created.
Records
itinerary.created: Always, withorigincreated.
Read an uploaded file into a draft without saving anything.
Triggered by
POST /v1/itineraries/preview:postItineraryPreview,mountaya.studio.itineraries.postItineraryPreview()in TypeScript. Every file read.
Records no webhook event.
Create an itinerary from a confirmed import.
Triggered by
POST /v1/itineraries/import:postItineraryImport,mountaya.studio.itineraries.postItineraryImport()in TypeScript. Every import confirmed.
Records
itinerary.created: Always, withoriginimported. Its segments and waypoints are part of it, and record no event of their own.
Copy an itinerary.
Triggered by
POST /v1/itineraries/{itinerary_id}/duplicate:postItineraryDuplicate,mountaya.studio.itineraries.postItineraryDuplicate()in TypeScript. Every copy made.
Records
itinerary.created: Always, for the copy, withoriginduplicated. The itinerary copied is not changed.
Change an itinerary's own fields.
Triggered by
PATCH /v1/itineraries/{itinerary_id}:patchItinerary,mountaya.studio.itineraries.patchItinerary()in TypeScript. Every change accepted.
Records
itinerary.updated: Always: every accepted change writes a new revision, one that sends the values already held included.
Delete an itinerary.
Triggered by
DELETE /v1/itineraries/{itinerary_id}:deleteItinerary,mountaya.studio.itineraries.deleteItinerary()in TypeScript. Every itinerary deleted.
Records
itinerary.deleted: Always.collection.itinerary.removed: Once for each collection that held the itinerary.
Publish an itinerary.
Triggered by
POST /v1/itineraries/{itinerary_id}/publication:postItineraryPublication,mountaya.studio.itineraries.postItineraryPublication()in TypeScript. Every publication.
Records
itinerary.published: Always: a republication replaces the live publication and is recorded too.
Take an itinerary's publication down.
Triggered by
DELETE /v1/itineraries/{itinerary_id}/publication:deleteItineraryPublication,mountaya.studio.itineraries.deleteItineraryPublication()in TypeScript. Every request.
Records
itinerary.unpublished: When the itinerary was published. Taking down what is not published records nothing.
Append a segment to an itinerary.
Triggered by
POST /v1/itineraries/{itinerary_id}/segments:postItinerarySegment,mountaya.studio.itineraries.postItinerarySegment()in TypeScript. A request that names nobefore_segment_id.
Records
itinerary.segment.created: Always. The new segment starts where the last one ends, which is not changed.
Insert a segment between two others.
Triggered by
POST /v1/itineraries/{itinerary_id}/segments:postItinerarySegment,mountaya.studio.itineraries.postItinerarySegment()in TypeScript. A request that names abefore_segment_id.
Records
itinerary.segment.created: Always.itinerary.segment.updated: For each neighbour re-routed to meet the new segment, at most two.itinerary.segment_group.deleted: For each group of the itinerary the change leaves fewer than two segments, which dissolves it. The change takes no segment out of a group, so this is only ever a group that already held fewer than two.
Change a segment.
Triggered by
PATCH /v1/itineraries/{itinerary_id}/segments/{segment_id}:patchItinerarySegment,mountaya.studio.itineraries.patchItinerarySegment()in TypeScript. Every change accepted.
Records
itinerary.segment.updated: Always for the segment, whose every accepted change writes a new revision, one that sends the values already held included, and for each neighbour re-routed because a new geometry moved the point they share.itinerary.segment_group.deleted: For each group of the itinerary the change leaves fewer than two segments, which dissolves it. The change takes no segment out of a group, so this is only ever a group that already held fewer than two.
Remove the first or the last segment of an itinerary.
Triggered by
DELETE /v1/itineraries/{itinerary_id}/segments/{segment_id}:deleteItinerarySegment,mountaya.studio.itineraries.deleteItinerarySegment()in TypeScript. Every segment removed.
Records
itinerary.segment.deleted: Always.itinerary.segment_group.deleted: When the segment's group is left fewer than two segments, which dissolves it.
Merge a segment with the one after it.
Triggered by
POST /v1/itineraries/{itinerary_id}/segments/{segment_id}/merge:postItinerarySegmentMerge,mountaya.studio.itineraries.postItinerarySegmentMerge()in TypeScript. Every merge.
Records
itinerary.segment.merged: Always, for the segment kept.itinerary.segment.deleted: Always, for the segment absorbed.itinerary.segment_group.deleted: When the merge leaves a group fewer than two segments, which dissolves it.
Cut a segment in two.
Triggered by
POST /v1/itineraries/{itinerary_id}/segments/{segment_id}/split:postItinerarySegmentSplit,mountaya.studio.itineraries.postItinerarySegmentSplit()in TypeScript. Every split.
Records
itinerary.segment.split: Always, for the segment cut, which is the first half.itinerary.segment.created: Always, for the second half.itinerary.segment_group.deleted: For each group of the itinerary the change leaves fewer than two segments, which dissolves it. The change takes no segment out of a group, so this is only ever a group that already held fewer than two.
Convert a segment between routed and freehand.
Triggered by
POST /v1/itineraries/{itinerary_id}/segments/{segment_id}/convert:postItinerarySegmentConvert,mountaya.studio.itineraries.postItinerarySegmentConvert()in TypeScript. Every request.
Records
itinerary.segment.converted: When the mode changes. A segment already in the mode asked for records nothing.itinerary.segment_group.deleted: For each group of the itinerary the change leaves fewer than two segments, which dissolves it. The change takes no segment out of a group, so this is only ever a group that already held fewer than two.
Group segments.
Triggered by
POST /v1/itineraries/{itinerary_id}/segment-groups:postItinerarySegmentGroup,mountaya.studio.itineraries.postItinerarySegmentGroup()in TypeScript. Every group created.
Records
itinerary.segment_group.created: Always.itinerary.segment_group.deleted: For each group of the itinerary the change leaves fewer than two segments, which dissolves it. The change takes no segment out of a group, so this is only ever a group that already held fewer than two.
Change a segment group.
Triggered by
PATCH /v1/itineraries/{itinerary_id}/segment-groups/{group_id}:patchItinerarySegmentGroup,mountaya.studio.itineraries.patchItinerarySegmentGroup()in TypeScript. Every change accepted.
Records
itinerary.segment_group.updated: When the group keeps at least two segments: every accepted change writes a new revision of it, one that sends the values already held included.itinerary.segment_group.deleted: For each group of the itinerary the change leaves fewer than two segments, which dissolves it: the group itself when the change takes segments out of it, and any other group that already held fewer than two.
Dissolve a segment group.
Triggered by
DELETE /v1/itineraries/{itinerary_id}/segment-groups/{group_id}:deleteItinerarySegmentGroup,mountaya.studio.itineraries.deleteItinerarySegmentGroup()in TypeScript. Every group deleted.
Records
itinerary.segment_group.deleted: Always. Its segments are kept, ungrouped, and record no event of their own.
Add a waypoint to an itinerary.
Triggered by
POST /v1/itineraries/{itinerary_id}/waypoints:postItineraryWaypoint,mountaya.studio.itineraries.postItineraryWaypoint()in TypeScript. Every waypoint added.
Records
itinerary.waypoint.created: Always.
Change a waypoint.
Triggered by
PATCH /v1/itineraries/{itinerary_id}/waypoints/{waypoint_id}:patchItineraryWaypoint,mountaya.studio.itineraries.patchItineraryWaypoint()in TypeScript. Every change accepted.
Records
itinerary.waypoint.updated: Always: every accepted change writes a new revision, one that sends the values already held included.
Remove a waypoint.
Triggered by
DELETE /v1/itineraries/{itinerary_id}/waypoints/{waypoint_id}:deleteItineraryWaypoint,mountaya.studio.itineraries.deleteItineraryWaypoint()in TypeScript. Every waypoint removed.
Records
itinerary.waypoint.deleted: Always.
Mint an itinerary's share link, or return the one it has.
Triggered by
POST /v1/itineraries/{itinerary_id}/share-link:postItineraryShareLink,mountaya.studio.itineraries.postItineraryShareLink()in TypeScript. Every request.
Records
itinerary.share_link.created: When the link is minted. Returning the link the itinerary already has records nothing.
Give an itinerary's share link a new token.
Triggered by
POST /v1/itineraries/{itinerary_id}/share-link/rotate:postItineraryShareLinkRotate,mountaya.studio.itineraries.postItineraryShareLinkRotate()in TypeScript. Every rotation.
Records
itinerary.share_link.rotated: Always.
Remove an itinerary's share link.
Triggered by
DELETE /v1/itineraries/{itinerary_id}/share-link:deleteItineraryShareLink,mountaya.studio.itineraries.deleteItineraryShareLink()in TypeScript. Every request.
Records
itinerary.share_link.deleted: When the itinerary had a link. Removing one that is not there records nothing.
Send a collaboration signal into an itinerary's session.
A signal says where its sender is and what they are drafting; it changes nothing that is kept.
Triggered by
POST /v1/itineraries/{itinerary_id}/collab:postItineraryCollab,mountaya.studio.collab.postItineraryCollab()in TypeScript. Every signal.
Records no webhook event.
Create a zone.
Triggered by
POST /v1/zones:postZone,mountaya.studio.zones.postZone()in TypeScript. Every zone created.
Records
zone.created: Always.
Change a zone.
Triggered by
PATCH /v1/zones/{zone_id}:patchZone,mountaya.studio.zones.patchZone()in TypeScript. Every change accepted.
Records
zone.updated: Always: every accepted change writes a new revision, one that sends the values already held included.
Delete a zone.
Triggered by
DELETE /v1/zones/{zone_id}:deleteZone,mountaya.studio.zones.deleteZone()in TypeScript. Every zone deleted.
Records
zone.deleted: Always.collection.zone.removed: Once for each collection that held the zone.
Publish a zone.
Triggered by
POST /v1/zones/{zone_id}/publication:postZonePublication,mountaya.studio.zones.postZonePublication()in TypeScript. Every publication.
Records
zone.published: Always: a republication replaces the live publication and is recorded too.
Take a zone's publication down.
Triggered by
DELETE /v1/zones/{zone_id}/publication:deleteZonePublication,mountaya.studio.zones.deleteZonePublication()in TypeScript. Every request.
Records
zone.unpublished: When the zone was published. Taking down what is not published records nothing.
Send a collaboration signal into a zone's session.
A signal says where its sender is and what they are drafting; it changes nothing that is kept.
Triggered by
POST /v1/zones/{zone_id}/collab:postZoneCollab,mountaya.studio.collab.postZoneCollab()in TypeScript. Every signal.
Records no webhook event.
Create a collection.
Triggered by
POST /v1/collections:postCollection,mountaya.studio.collections.postCollection()in TypeScript. Every collection created.
Records
collection.created: Always.
Change a collection's own fields.
Triggered by
PATCH /v1/collections/{collection_id}:patchCollection,mountaya.studio.collections.patchCollection()in TypeScript. Every change accepted.
Records
collection.updated: When a field changes. A request sending the values the collection already holds writes nothing and records nothing.
Delete a collection.
Triggered by
DELETE /v1/collections/{collection_id}:deleteCollection,mountaya.studio.collections.deleteCollection()in TypeScript. Every collection deleted.
Records
collection.deleted: Always. The itineraries and zones it held are not changed, and leave it without an event of their own.
Add itineraries to a collection.
Triggered by
POST /v1/collections/{collection_id}/itineraries:postCollectionItineraries,mountaya.studio.collections.postCollectionItineraries()in TypeScript. Every request.
Records
collection.itinerary.added: Once for each itinerary the collection did not hold. One it holds keeps its place and records nothing.
Move an itinerary within a collection.
Triggered by
PATCH /v1/collections/{collection_id}/itineraries/{itinerary_id}:patchCollectionItinerary,mountaya.studio.collections.patchCollectionItinerary()in TypeScript. Every request.
Records
collection.itinerary.moved: When the itinerary's position changes. A request naming the position it holds records nothing.
Remove an itinerary from a collection.
Triggered by
DELETE /v1/collections/{collection_id}/itineraries/{itinerary_id}:deleteCollectionItinerary,mountaya.studio.collections.deleteCollectionItinerary()in TypeScript. Every request.
Records
collection.itinerary.removed: When the collection held the itinerary.
Add zones to a collection.
Triggered by
POST /v1/collections/{collection_id}/zones:postCollectionZones,mountaya.studio.collections.postCollectionZones()in TypeScript. Every request.
Records
collection.zone.added: Once for each zone the collection did not hold.
Remove a zone from a collection.
Triggered by
DELETE /v1/collections/{collection_id}/zones/{zone_id}:deleteCollectionZone,mountaya.studio.collections.deleteCollectionZone()in TypeScript. Every request.
Records
collection.zone.removed: When the collection held the zone.
Mint a collection's share link, or return the one it has.
Triggered by
POST /v1/collections/{collection_id}/share-link:postCollectionShareLink,mountaya.studio.collections.postCollectionShareLink()in TypeScript. Every request.
Records
collection.share_link.created: When the link is minted. Returning the link the collection already has records nothing.
Give a collection's share link a new token.
Triggered by
POST /v1/collections/{collection_id}/share-link/rotate:postCollectionShareLinkRotate,mountaya.studio.collections.postCollectionShareLinkRotate()in TypeScript. Every rotation.
Records
collection.share_link.rotated: Always.
Remove a collection's share link.
Triggered by
DELETE /v1/collections/{collection_id}/share-link:deleteCollectionShareLink,mountaya.studio.collections.deleteCollectionShareLink()in TypeScript. Every request.
Records
collection.share_link.deleted: When the collection had a link. Removing one that is not there records nothing.
Create an organization.
Triggered by
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.
Records
organization.created: Always.organization.member.created: Always, for its owner, the user who created it.
Change an organization's own fields.
Triggered by
PATCH /v1/organizations/{organization_id}:patchOrganization,mountaya.admin.organizations.patchOrganization()in TypeScript. Every change accepted.
Records
organization.updated: When the name changes. A request naming the name the organization already holds writes nothing and records nothing.
Write an organization's Map Publishing settings.
Triggered by
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.
Records
organization.settings.updated: Always: every accepted write replaces the settings and moves their version, one that sends the settings already held included.
Record what an organization holds.
Triggered by
- 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.
Records
organization.entitlements.updated: When what the organization holds changes. A recomputation that finds it unchanged records nothing.
Hand an organization on to another member.
Triggered by
- Mountaya's web application: The owner hands the organization on, signed in to Mountaya's web application.
Records
organization.member.updated: Twice: for the member who becomes owner, and for the former owner, who becomes an admin.
Change a member's role.
Triggered by
PATCH /v1/organizations/{organization_id}/members/{user_id}:patchOrganizationMember,mountaya.admin.members.patchOrganizationMember()in TypeScript. Every request.- Mountaya's web application: A role changed signed in to Mountaya's web application.
Records
organization.member.updated: When the role changes. A request naming the role the member holds records nothing.
Remove a member from an organization.
Triggered by
DELETE /v1/organizations/{organization_id}/members/{user_id}:deleteOrganizationMember,mountaya.admin.members.deleteOrganizationMember()in TypeScript. A request naming a member other than the user it acts as.- Mountaya's web application: A member removed signed in to Mountaya's web application.
Records
organization.member.deleted: When the user was a member, withreasonremoved.
Leave an organization.
Triggered by
DELETE /v1/organizations/{organization_id}/members/{user_id}:deleteOrganizationMember,mountaya.admin.members.deleteOrganizationMember()in TypeScript. A request naming the user it acts as.- Mountaya's web application: A member leaving signed in to Mountaya's web application.
Records
organization.member.deleted: When the user was a member, withreasonleft.
Change which notification emails a member receives.
Triggered by
PATCH /v1/me/organizations/{organization_id}/notification-preferences:patchMyOrganizationNotificationPreferences,mountaya.admin.users.patchMyOrganizationNotificationPreferences()in TypeScript. Every change accepted.
Records no webhook event.
Invite somebody to an organization.
Triggered by
POST /v1/organizations/{organization_id}/invitations:postOrganizationInvitation,mountaya.admin.invitations.postOrganizationInvitation()in TypeScript. Every invitation made.- Mountaya's web application: An invitation made signed in to Mountaya's web application.
Records
organization.invitation.created: Always.organization.invitation.expired: Once for each invitation of the organization that had lapsed unanswered, cleared before the new one is counted against the seats.
Withdraw an invitation.
Triggered by
DELETE /v1/organizations/{organization_id}/invitations/{invitation_id}:deleteOrganizationInvitation,mountaya.admin.invitations.deleteOrganizationInvitation()in TypeScript. Every request.- Mountaya's web application: An invitation withdrawn signed in to Mountaya's web application.
Records
organization.invitation.revoked: When the invitation was waiting for an answer.organization.invitation.expired: When the invitation had lapsed unanswered and had not been cleared yet.
Accept an invitation.
Triggered by
POST /v1/me/invitations/{invitation_id}/accept:postMyInvitationAccept,mountaya.admin.users.postMyInvitationAccept()in TypeScript. Every invitation accepted.- Mountaya's web application: An invitation accepted signed in to Mountaya's web application.
Records
organization.invitation.accepted: Always.organization.member.created: When the person was not a member already.organization.invitation.deleted: Once for each other invitation of the person to the same organization, which joining supersedes.
Decline an invitation.
Triggered by
DELETE /v1/me/invitations/{invitation_id}:deleteMyInvitation,mountaya.admin.users.deleteMyInvitation()in TypeScript. Every request.- Mountaya's web application: An invitation declined signed in to Mountaya's web application.
Records
organization.invitation.declined: When the invitation was waiting for the person.
Clear the invitations that lapsed unanswered.
Triggered by
- A schedule: Every hour.
Records
organization.invitation.expired: Once for each invitation that lapsed since the last run.
Change a person's display preferences.
Triggered by
PATCH /v1/me/preferences:patchMyPreferences,mountaya.admin.users.patchMyPreferences()in TypeScript. Every change accepted.
Records no webhook event.
Create a publishable key.
Triggered by
POST /v1/organizations/{organization_id}/publishable-keys:postOrganizationPublishableKey,mountaya.admin.keys.postOrganizationPublishableKey()in TypeScript. Every key created.
Records
organization.publishable_key.created: Always.
Change a publishable key's name or scopes.
Triggered by
PATCH /v1/organizations/{organization_id}/publishable-keys/{key_id}:patchOrganizationPublishableKey,mountaya.admin.keys.patchOrganizationPublishableKey()in TypeScript. Every change accepted.
Records
organization.publishable_key.updated: When the name or the scopes change. A request sending the values the key already holds writes nothing and records nothing.
Revoke a publishable key.
Triggered by
DELETE /v1/organizations/{organization_id}/publishable-keys/{key_id}:deleteOrganizationPublishableKey,mountaya.admin.keys.deleteOrganizationPublishableKey()in TypeScript. Every request.
Records
organization.publishable_key.revoked: When the key was in force. Revoking a revoked key records nothing.
Create a secret key.
Triggered by
- Mountaya's web application: A secret key created signed in to Mountaya's web application.
Records
organization.secret_key.created: Always.
Rename a secret key.
Triggered by
- Mountaya's web application: A secret key renamed signed in to Mountaya's web application.
Records
organization.secret_key.updated: When the name changes. Renaming a key to the name it already holds writes nothing and records nothing.
Revoke a secret key.
Triggered by
- Mountaya's web application: A secret key revoked signed in to Mountaya's web application.
Records
organization.secret_key.revoked: When the key was in force.
Configure an organization's AI provider.
Triggered by
POST /v1/organizations/{organization_id}/ai-provider-config:postOrganizationAiProviderConfig,mountaya.admin.organizations.postOrganizationAiProviderConfig()in TypeScript. Every configuration created.
Records
Change an organization's AI provider configuration.
Triggered by
PATCH /v1/organizations/{organization_id}/ai-provider-config:patchOrganizationAiProviderConfig,mountaya.admin.organizations.patchOrganizationAiProviderConfig()in TypeScript. Every change accepted.
Records
organization.ai_provider_config.updated: When the model or the base URL changes, or when a credential is sent, which replaces the one stored. A request sending the model and the base URL already held, and no credential, writes nothing and records nothing.
Delete an organization's AI provider configuration.
Triggered by
DELETE /v1/organizations/{organization_id}/ai-provider-config:deleteOrganizationAiProviderConfig,mountaya.admin.organizations.deleteOrganizationAiProviderConfig()in TypeScript. Every request.
Records
organization.ai_provider_config.deleted: When one was configured. Deleting none records nothing.
Open an organization's billing account.
Opening the account changes nothing a webhook event carries: the subscription is opened by the first card.
Triggered by
POST /v1/organizations/{organization_id}/billing/provision:postOrganizationBillingProvision,mountaya.admin.billing.postOrganizationBillingProvision()in TypeScript. Every request.
Records no webhook event.
Run an organization's Data API subscription.
Triggered by
POST /v1/organizations/{organization_id}/billing/subscription:postOrganizationBillingSubscription,mountaya.admin.billing.postOrganizationBillingSubscription()in TypeScript. Every request.
Records
organization.billing.subscription.created: When the organization held none and one is opened.organization.billing.subscription.updated: When an end scheduled for the subscription is taken back.
End an organization's Data API subscription at the end of its period.
Triggered by
DELETE /v1/organizations/{organization_id}/billing/subscription:deleteOrganizationBillingSubscription,mountaya.admin.billing.deleteOrganizationBillingSubscription()in TypeScript. Every request.
Records
organization.billing.subscription.updated: When an end is scheduled, withcancel_at_period_endtrue. The end itself isorganization.billing.subscription.canceled, recorded when the period closes.
Record a change the payment provider reports on a Data API subscription.
Triggered by
- The payment provider: The payment provider reports a change to the organization's Data API subscription.
- A schedule: Every day, and every week, a check finds the subscription changed at the payment provider in a way not recorded yet.
- Mountaya's staff: Mountaya's staff move the organization to an agreement, which ends its Data API subscription at the end of its period.
Records
organization.billing.subscription.created: When the report is of a subscription the organization did not hold.organization.billing.subscription.updated: When its status, its scheduled end or its period changes.organization.billing.subscription.paused: When collection on it is paused.organization.billing.subscription.resumed: When collection on it resumes.organization.billing.subscription.canceled: When it ends.
Record what the payment provider reports on an invoice.
Triggered by
- The payment provider: The payment provider reports an invoice paid, a payment failed, or a payment waiting for the payer.
Records
organization.billing.invoice.paid: When the invoice is paid.organization.billing.invoice.payment_failed: When a payment of it fails.organization.billing.invoice.payment_action_required: When a payment of it waits for the payer to confirm it.
Write what an organization's invoices are addressed to.
Triggered by
PATCH /v1/organizations/{organization_id}/billing/info:patchOrganizationBillingInfo,mountaya.admin.billing.patchOrganizationBillingInfo()in TypeScript. Every change accepted.
Records
organization.billing.info.updated: When the request names at least one part of the billing information, each named infields. A request naming none writes nothing and records nothing.
Start confirming a new payment method.
Nothing is saved until the payment method is confirmed and attached, which records organization.billing.payment_method.attached.
Triggered by
POST /v1/organizations/{organization_id}/billing/payment-methods/setup:postOrganizationBillingPaymentMethodSetup,mountaya.admin.billing.postOrganizationBillingPaymentMethodSetup()in TypeScript. Every request.
Records no webhook event.
Save a confirmed payment method.
Triggered by
POST /v1/organizations/{organization_id}/billing/payment-methods:postOrganizationBillingPaymentMethod,mountaya.admin.billing.postOrganizationBillingPaymentMethod()in TypeScript. Every payment method saved.- The payment provider: The payment provider reports a payment method confirmed, as a method that confirms after the request does.
- A schedule: Every day, a check finds that the payment method the organization is charged on was saved without being recorded, and records it.
Records
organization.billing.payment_method.attached: Once for each payment method saved, whether or not it becomes the one the organization is charged on:is_defaultsays whether it was when the event was recorded.organization.billing.payment_method.updated: When the payment method saved becomes the one the organization is charged on: once for it and once for the former default.organization.billing.info.updated: When the organization's billing information held no address and the payment method's is copied to it, withfieldsnamingaddress.organization.billing.subscription.created: When the first card opens the organization's Data API subscription.
Remove a payment method.
Triggered by
DELETE /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}:deleteOrganizationBillingPaymentMethod,mountaya.admin.billing.deleteOrganizationBillingPaymentMethod()in TypeScript. Every payment method removed.
Records
Make a payment method the one the organization is charged on.
Triggered by
POST /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/set-default:postOrganizationBillingPaymentMethodSetDefault,mountaya.admin.billing.postOrganizationBillingPaymentMethodSetDefault()in TypeScript. Every request.
Records
organization.billing.payment_method.updated: When the default changes: once for the new default and once for the former one.
Create a webhook endpoint.
Triggered by
POST /v1/organizations/{organization_id}/webhook-endpoints:postOrganizationWebhookEndpoint,mountaya.admin.webhooks.postOrganizationWebhookEndpoint()in TypeScript. Every endpoint created.- Mountaya's web application: An endpoint created signed in to Mountaya's web application.
Records
Change a webhook endpoint.
Triggered by
PATCH /v1/organizations/{organization_id}/webhook-endpoints/{webhook_endpoint_id}:patchOrganizationWebhookEndpoint,mountaya.admin.webhooks.patchOrganizationWebhookEndpoint()in TypeScript. Every change accepted.- Mountaya's web application: An endpoint changed, enabled or disabled signed in to Mountaya's web application.
Records
organization.webhook_endpoint.updated: When its URL, description or event types are written.organization.webhook_endpoint.enabled: When a disabled endpoint is enabled.organization.webhook_endpoint.disabled: When an enabled endpoint is disabled, withdisabled_reasonrequested.
Delete a webhook endpoint.
Triggered by
DELETE /v1/organizations/{organization_id}/webhook-endpoints/{webhook_endpoint_id}:deleteOrganizationWebhookEndpoint,mountaya.admin.webhooks.deleteOrganizationWebhookEndpoint()in TypeScript. Every endpoint deleted.- Mountaya's web application: An endpoint deleted signed in to Mountaya's web application.
Records
Replace a webhook endpoint's signing secret.
Triggered by
- Mountaya's web application: A secret rotated signed in to Mountaya's web application.
Records
Watch the webhook endpoints whose deliveries fail.
Triggered by
- A schedule: Every hour.
- Mountaya: Each delivery attempt recorded.
Records
organization.webhook_endpoint.failing: When every delivery to an endpoint has failed for 24 hours.organization.webhook_endpoint.disabled: When every delivery to an endpoint has failed for 72 hours, withdisabled_reasonfailing.organization.webhook_endpoint.recovered: When a delivery succeeds to an endpoint whose run of failed deliveries was reported failing.
Deliver one event to an endpoint again.
Triggered by
POST /v1/organizations/{organization_id}/webhook-deliveries:postOrganizationWebhookDelivery,mountaya.admin.webhooks.postOrganizationWebhookDelivery()in TypeScript. A request naming anevent_id.- Mountaya's web application: A resend asked for signed in to Mountaya's web application.
Records no webhook event.
Send an endpoint a test event.
Triggered by
POST /v1/organizations/{organization_id}/webhook-deliveries:postOrganizationWebhookDelivery,mountaya.admin.webhooks.postOrganizationWebhookDelivery()in TypeScript. A request naming atest.- Mountaya's web application: A test event sent signed in to Mountaya's web application.
Records no webhook event.
Deliver an endpoint every event it was sent since an instant.
Triggered by
POST /v1/organizations/{organization_id}/webhook-deliveries:postOrganizationWebhookDelivery,mountaya.admin.webhooks.postOrganizationWebhookDelivery()in TypeScript. A request naming asince.- Mountaya's web application: A redelivery asked for signed in to Mountaya's web application.
Records no webhook event.