SDK Reference
Go: Webhooks
Overview
Register webhook endpoints and verify signed payloads in your integration service.
SDK helpers validate HMAC signatures and parse typed event envelopes.
Who should read this
- QA engineers, SREs, platform teams, and developers operating Zof Console and APIs.
Prerequisites
- Go runtime installed
- Organization API key
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
client.webhooks.create with HTTPS URL and event list.
Verify signatures
Use SDK verifySignature helper with raw body and header.
Key concepts
- Organization scope
- All Zof Console and API operations are isolated to your authenticated tenant.
- Governed execution
- Agent output and remediation follow policy packs with human approval when configured.
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.
Example
const endpoint = await client.webhooks.create({ url: 'https://hooks.example.com/zof', events: ['run.completed'] });Was this page helpful?
