Examples

Slack approval notification

Overview

Notify approvers when remediation.plan_pending fires.

Examples use staging environments and synthetic identifiers. Replace project IDs, suite names, and webhook URLs with your organization values.

Who should read this

QA engineers, SREs, platform teams, and developers operating Zof Console and APIs.

Prerequisites

Organization API key or authenticated CLI
Staging environment for safe experimentation

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

Prepare environment

Store ZOF_API_KEY in CI secrets or local env.

Confirm target project and suite IDs in Console.

Apply pattern

Copy example configuration into your pipeline or service.

Adjust environment names and notification channels.

Validate

Run once manually before enforcing gates.

Capture run ID in runbook for support reference.

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 implementation

if event.type == "remediation.plan_pending":
    slack.post_message(channel="#release-approvals",
      text=f"Approval required: {event.data.plan_url}")

Was this page helpful?