Developers

Webhooks

Event-driven notifications for run completion, failures, and governance events.

Overview

Webhooks deliver real-time notifications to your HTTPS endpoints when platform events occur, reducing polling and enabling incident response automation.

Each endpoint has a signing secret; validate the signature before processing payload to prevent spoofing.

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

Register endpoint

Admin → Developer → Webhooks or POST /v1/webhooks.

Select events and generate secret.

Implement handler

Verify signature header.

Return 200 quickly; queue heavy processing.

Test delivery

Use test event from Console or API.

Confirm receipt in your logs.

Key concepts

run.completed
Validation run finished (any terminal status).
run.failed
Run failed with one or more case failures.
remediation.plan_pending
Remediation plan awaiting human approval.
agent.offline
Execution agent missed heartbeat threshold.

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?

Webhooks | Zof AI Documentation