Webhooks & Events
Event reference
All event types.
Overview
Complete catalog of webhook event types emitted by the Zof platform when runs complete, gates block, agents go offline, or remediation requires approval.
Subscribe only to events your integration requires to reduce noise, simplify verification, and limit blast radius if an endpoint is compromised.
Step-by-step procedure
Select events
CI systems typically need run.completed and run.failed.
Governance workflows add remediation.plan_pending and release.gate_blocked.
Register endpoint
Admin Center → Developer → Webhooks or POST /v1/webhooks.
Store signing secret in vault; verify HMAC on every delivery.
Key concepts
- run.completed
- Fired when a validation run reaches a terminal state (passed, failed, or canceled).
- run.failed
- Fired when a run fails critical cases or exceeds failure thresholds configured in policy.
- run.started
- Fired when orchestration begins dispatching cases to execution agents.
- remediation.plan_pending
- Fired when a remediation plan awaits human authorization in the approvals queue.
- remediation.approved
- Fired after an approver authorizes a remediation plan to proceed.
- agent.offline
- Fired when an execution agent misses heartbeat thresholds.
- release.gate_blocked
- Fired when a release gate blocks ship due to failed validation or policy violation.
- integration.error
- Fired when an external integration connection fails health checks.
Bind event handling to the supported schema
Record the event name, schema version if supplied, source resource, occurrence time, and correlation information needed by your consumer. Handle unknown optional fields without losing the original event context, and reject missing required fields according to the supported contract.
Use sanitized fixtures to test expected events, malformed input, duplicates, and out-of-order delivery. Review whether a notification carries a state snapshot or only a signal to retrieve current state; the distinction affects reconciliation and retry handling.
Was this page helpful?