/docs/api/webhooks

Webhooks

obsrv delivers signed webhooks for trace events, metric thresholds, monitor state changes, and cluster shifts.

Subscribe

POST /v1/projects/proj_…/webhooks
x-api-key: tk_live_…

{
  "url": "https://example.com/client",
  "events": ["trace.flagged", "monitor.fired", "cluster.created"],
  "secret": "whsec_…"
}

Event types

  • trace.committed — every committed trace.
  • trace.flagged — a trace was marked failed or explicitly flagged.
  • metric.event — a new metric event was recorded.
  • monitor.fired — a monitor crossed its threshold.
  • monitor.resolved — a monitor returned to normal.
  • cluster.created — a new cluster appeared in your project.
  • cluster.shifted — an existing cluster's membership changed materially.

Signature

Every webhook is signed with HMAC-SHA256 over the raw body, using the secret you registered. Verify the X-Obsrv-Signature header before processing.

Delivery & retries

obsrv retries failures with exponential backoff for up to 24 hours. Per-event delivery history is visible in the dashboard.