Webhooks

Read a webhook

One subscription, with its health: when the endpoint last accepted a delivery, when one last failed, the status of the newest attempt, and whether the platform has disabled it. Never the secret.

Requires the viewer role or higher.

get/webhooks/{id}

Request

  • Base URL: https://app.mandala.computer/api/v1
  • URL: https://app.mandala.computer/api/v1/webhooks/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The webhook id.

Response

The subscription.

idstring required

whk- and sixteen hex characters.

urlstring required

Where deliveries are POSTed. https:// only. The URL as the platform parsed it, which can differ in spelling from what you sent: the host lower-cased, a default port dropped, a bare origin ending in /.

descriptionstring required

Free text, for your listing. Empty when you gave none.

eventsstring[] required

The event types this subscription receives. Empty means every type. The vocabulary is the event socket’s (the computer’s events_url) less file.changed: window.opened, window.closed, window.focused, window.blurred, clipboard.changed, process.exited, computer.idle, computer.ready, computer.started, computer.stopped, computer.suspended.

computersstring[] required

The computer ids this subscription receives events for. Empty means every computer in scope. Not checked against your computers when you set it — a subscription may name a computer you are about to create.

enabledboolean required

Whether deliveries are made. Set false by the platform when an endpoint has failed for a day, or when the account moves to a plan without webhooks — see disabled_reason. Back to true by you with PATCH, which starts fresh, or, for plan, by the platform when you choose a plan again, which starts fresh too.

disabled_reason'customer' | 'failing' | 'plan' | 'null' nullable required

Why enabled is false: customer when you disabled it, failing when the platform did — a delivery ran out of attempts and nothing had been accepted for 24 hours, counted from the later of the last 2xx and when the subscription was last enabled — and plan when the account moved to a plan without webhooks. A plan subscription is enabled again, oldest first, as many as the plan allows, when the account chooses a plan that includes webhooks. null while enabled.

disabled_atstring nullable required

RFC 3339 timestamp, or null while enabled.

last_success_atstring nullable required

When the endpoint last answered 2xx to any delivery. null until it has.

last_failure_atstring nullable required

When a delivery attempt last failed. null until one has.

last_statusinteger nullable required

The HTTP status of the newest attempt, whatever it was. null before any attempt, or when the newest got no answer.

workspace_idstring

The workspace this subscription is confined to. Present only when it was created with a workspace-scoped API key; absent on an account-wide subscription.

created_atstring required

RFC 3339 timestamp.

updated_atstring required

RFC 3339 timestamp.

Changes

No recorded changes to this operation across all 1 revision of this API.