Health

Maintenance started

Fires when a previously scheduled maintenance window begins; the affected service's or operation's effective status is recomputed and reports under_maintenance, unless an organic outage is already in progress, which continues to take priority. Subscribe to react in real time when a dependency enters maintenance.

postWebhookhealthMaintenanceStarted

Payload

eventIdstring uuid required

Unique identifier for this logical webhook event. Webhooks are delivered at least once, so your endpoint may receive duplicate deliveries for the same event. Use this eventId as the idempotency/deduplication key.

timestampstring date-time required

The UTC ISO 8601 timestamp at which this event's transition occurred, not the time at which this webhook was delivered.

eventType'health.maintenance.started' required

The type of webhook event.

Example payload

{
  "eventType": "health.maintenance.started",
  "eventId": "9d3f2b1a-6e4c-4a8b-9f1d-2c7a5e8b4f60",
  "timestamp": "2026-04-22T02:00:00.000Z",
  "data": {
    "service": "payments_acceptance",
    "operation": "account_linking",
    "startsAt": "2026-04-22T02:00:00.000Z",
    "expectedDurationSeconds": 7200,
    "status": "started",
    "message": "Maintenance window has begun."
  }
}

Response

Webhook received and processed successfully.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.