Webhooks & Events
Event catalog
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.
Who should read this
- QA engineers, SREs, platform teams, and developers operating Zof Console and APIs.
When to use this workflow
- Onboarding new team members to Zof terminology and workflows
- Authoring internal runbooks aligned with Console labels
- Designing CI/CD or webhook integrations against documented behavior
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.
Best practices
- Validate changes in staging before applying release gates to production.
- Include run IDs and timestamps when escalating issues to support or auditors.
- Align internal runbook terminology with Zof Console UI labels for clarity.
Was this page helpful?
