Get started
Webhooks

organization.webhook_endpoint

organization.webhook_endpoint

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

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.

The WebhookEndpointEventObject object

A webhook endpoint as a webhook event carries it: its identifiers, the host of its URL, its status and its version. Its URL is never carried, since a receiver's URL is often a credential of its own, and neither are its secret and the event types it is sent: getOrganizationWebhookEndpoint reads them.

object

string

required

One of: organization.webhook_endpoint

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

id

string (uuid)

required

Identifier of the endpoint.

organization_id

string (uuid)

required

Identifier of the organization the endpoint belongs to.

host

string

required

The host of the URL Mountaya delivers the endpoint's events to, with its port when the URL names one: never its path, its query or the credentials it may carry, which a receiver's URL often uses as its secret.

status

string

required

One of: enabled, disabled

Whether Mountaya delivers to the endpoint once this change was made.

disabled_reason

string

One of: requested, failing

Why the endpoint is disabled. Present while it is.

failing_since

string (date-time) | null

required

When the endpoint's run of failed deliveries began, null while its last delivery succeeded.

version

integer (int64)

required

The endpoint's version once this change was made. It climbs with every change to the endpoint's configuration and status, so of two events about one endpoint the one carrying the higher version is the later state: events are not delivered in order. Its health, failing_since, does not move it: a delivery failing or succeeding again changes no configuration, and a change asked with the endpoint's etag is never refused for it.

created_at

string (date-time)

required

When the endpoint was created.

updated_at

string (date-time)

required

When the endpoint's configuration or status last changed. Its health, failing_since, does not move it.

organization.webhook_endpoint.created

A webhook endpoint was created.

Triggered by

Payload

type

string

required

One of: organization.webhook_endpoint.created

Always organization.webhook_endpoint.created.

data.object

WebhookEndpointEventObject

required

The webhook endpoint.

See the WebhookEndpointEventObject object.

Every other field is the envelope every webhook event shares.

organization.webhook_endpoint.updated

A webhook endpoint's URL, description or event types were written.

Triggered by

  • organization.webhook_endpoint.update: When its URL, description or event types are written.
    • 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.

Payload

type

string

required

One of: organization.webhook_endpoint.updated

Always organization.webhook_endpoint.updated.

data.object

WebhookEndpointEventObject

required

The webhook endpoint.

See the WebhookEndpointEventObject 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.

organization.webhook_endpoint.deleted

A webhook endpoint was deleted, and nothing is delivered to it from then on.

Triggered by

  • organization.webhook_endpoint.delete: Always.
    • 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.

Payload

type

string

required

One of: organization.webhook_endpoint.deleted

Always organization.webhook_endpoint.deleted.

data.object

WebhookEndpointEventObject

required

The webhook endpoint.

See the WebhookEndpointEventObject object.

Every other field is the envelope every webhook event shares.

organization.webhook_endpoint.enabled

A disabled webhook endpoint was enabled again.

Triggered by

  • organization.webhook_endpoint.update: When a disabled endpoint is enabled.
    • 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.

Payload

type

string

required

One of: organization.webhook_endpoint.enabled

Always organization.webhook_endpoint.enabled.

data.object

WebhookEndpointEventObject

required

The webhook endpoint.

See the WebhookEndpointEventObject object.

Every other field is the envelope every webhook event shares.

organization.webhook_endpoint.disabled

A webhook endpoint was disabled: by a member, or by Mountaya after 72 hours of failed deliveries. disabled_reason says which.

Triggered by

  • organization.webhook_endpoint.update: When an enabled endpoint is disabled, with disabled_reason requested.
    • 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.
  • organization.webhook_endpoint.monitor: When every delivery to an endpoint has failed for 72 hours, with disabled_reason failing.
    • A schedule: Every hour.
    • Mountaya: Each delivery attempt recorded.

Payload

type

string

required

One of: organization.webhook_endpoint.disabled

Always organization.webhook_endpoint.disabled.

data.object

WebhookEndpointEventObject

required

The webhook endpoint.

See the WebhookEndpointEventObject object.

Every other field is the envelope every webhook event shares.

organization.webhook_endpoint.failing

Every delivery to a webhook endpoint has failed for 24 hours. Mountaya disables it at 72 hours unless one succeeds.

Triggered by

Payload

type

string

required

One of: organization.webhook_endpoint.failing

Always organization.webhook_endpoint.failing.

data.object

WebhookEndpointEventObject

required

The webhook endpoint.

See the WebhookEndpointEventObject object.

Every other field is the envelope every webhook event shares.

organization.webhook_endpoint.recovered

A delivery succeeded to a webhook endpoint whose run of failed deliveries was reported with organization.webhook_endpoint.failing: the run is over, and failing_since is null again. A run that ends before it was reported records nothing.

Triggered by

  • organization.webhook_endpoint.monitor: When a delivery succeeds to an endpoint whose run of failed deliveries was reported failing.
    • A schedule: Every hour.
    • Mountaya: Each delivery attempt recorded.

Payload

type

string

required

One of: organization.webhook_endpoint.recovered

Always organization.webhook_endpoint.recovered.

data.object

WebhookEndpointEventObject

required

The webhook endpoint.

See the WebhookEndpointEventObject object.

Every other field is the envelope every webhook event shares.

organization.webhook_endpoint.secret_rotated

A webhook endpoint's signing secret was replaced, signed in to Mountaya's web application. Both secrets sign deliveries for up to 7 days.

Triggered by

Payload

type

string

required

One of: organization.webhook_endpoint.secret_rotated

Always organization.webhook_endpoint.secret_rotated.

data.object

WebhookEndpointEventObject

required

The webhook endpoint.

See the WebhookEndpointEventObject object.

Every other field is the envelope every webhook event shares.