Developers

Configuration

Configure agents, thresholds, and execution policies.

Overview

Configuration spans organization defaults (Admin Center), project metadata (Console project settings), agent enablement (Automation → AI Agents), release thresholds (Governance → Policies), and local zof.config.js for CLI/CI execution.

Secrets (API keys, webhook signing secrets) belong in vaults and CI secret stores, never in committed configuration files.

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

Organization level

Admin Center → Platform → defaults for environments and retention.

Admin Center → Security → SSO and session policy.

Project level

Console → Project settings → application URL, test categories, team ownership.

Local / CI level

zof.config.js for projectId and defaultEnvironment.

CI secrets for ZOF_API_KEY and ZOF_PROJECT_ID.

Key concepts

zof.config.js
Project-root CLI config: projectId, defaultEnvironment, suite names, failOnError.
ZOF_API_KEY
Environment variable read by CLI and SDKs for Bearer authentication.
Organization policy
Admin-defined constraints on agents, environments, and approval workflows.

Best practices

  • Keep secrets in CI vaults, not zof.config.js
  • Use separate project IDs per environment
  • Document threshold changes in change management

CLI configuration

module.exports = {
  projectId: 'proj_abc123',
  defaultEnvironment: 'staging',
  agents: { accessibility: { enabled: true } },
  thresholds: { minimumPassRate: 0.95 },
};

Was this page helpful?

Configuration | Zof AI Documentation