Skip to main content

Published Updated

Release Approvals

Short answer

Release approvals record that specific people signed off on a version. Each approval shows that person's profile and the job role they held at the time. You can configure one deploy webhook that TestChimp calls when every required role and every required person has approved.

Approvals sit on the release detail title pane, next to version, due date, and deployments. They are separate from programmatic release gating, which reads test, issue, and scan data. An approval does not mark the release ready on its own.

Add or remove your approval​

Open the release. On the Approvals row:

  1. Add approval records the signed-in user. You approve as yourself. There is one approval per person per version.
  2. The row shows a profile picture and a tag with your job role.
  3. Click the tag's close control to remove your approval. You cannot remove someone else's.

Adding an approval that is already there does not send the deploy webhook again.

Job role​

The role on an approval is not chosen on the release page. Each person has one job role for the organization, set in Team settings (account menu, organization admins).

WhereTeam settings, Job role column on the members table, next to the TestChimp Admin / Viewer role
Defaultdev for existing members and for people who join later
Seeded rolesdev, qa-engineer, release manager, qa lead, ux lead, product manager, tech lead, product owner
Custom roles+ Add Role on the job-role dropdown appends a title to the organization's list (up to 64 characters)

The approval stores the role at the moment you click Add approval. A later edit in Team settings does not rewrite approvals already on a release.

Deploy webhook​

Project settings → Release Approvals (/project-config?tab=release-approvals) holds one deploy webhook per project.

  1. Turn Enabled on.
  2. Choose a template for your CI/CD (GitHub Actions, GitLab, Bitbucket, Azure DevOps, CircleCI, Jenkins, or Custom).
  3. Fill the template fields (repo, workflow, token, and so on) and set required roles and/or required people.
  4. Optionally open Advanced to edit the HTTP method, URL, headers, and body templates.
  5. Use Preview request (secrets redacted) or Send test request (a real HTTP call that may start a pipeline).

The webhook fires once when approval requirements flip from unmet to met. Extra approvals after that do not fire again. If an approval is removed and the requirements are later met again, it fires again with a new delivery id. An empty required list never fires.

Deliveries are logged with status, duration, the redacted request, and a response snippet. You can Re-send from the log or Fire now on a release that already meets its requirements.

Placeholders​

Templates can use:

  • {{release.version}}, {{release.gitCommitSha}}, {{release.url}}, {{release.branch}}, {{release.environment}}
  • {{approval.approvedBy}}, {{json approval.approvers}}, {{approval.triggeredBy}}
  • {{delivery.id}}, {{delivery.firedAt}}, {{delivery.isTest}}
  • {{project.id}}, {{project.name}}
  • {{params.<name>}}, {{secrets.<name>}}
  • Helpers: base64, concat, json, urlencode

HMAC (Custom)​

For Custom receivers, enable HMAC to send X-TestChimp-Signature: sha256=<hex> (HMAC-SHA256 of the raw body only) and X-TestChimp-Timestamp (informational ISO-8601; not included in the MAC). Reject replays in your receiver if needed (e.g. by remembering recent delivery ids from X-TestChimp-Delivery).

# Verify (example) — body only
printf '%s' "$BODY" | openssl dgst -sha256 -hmac "$SECRET"

Choose GitHub Actions: workflow_dispatch. Declare every input under on.workflow_dispatch.inputs in the workflow file on the chosen ref. Use a fine-grained PAT with Actions: Read and write.

Frequently asked questions

Who can approve a release?

Each signed-in project member can add and remove only their own approval. There is one approval per person per version.

Where is the job role set?

Organization admins set one job role per person in Team settings. The default is dev. The approval stores that role at approval time, so a later Team settings edit does not change history.

When does the deploy webhook fire?

Once when the required roles and people flip from unmet to met. Extra approvals after that do not fire again. An empty required list never fires. Retries use the same delivery id.

Sign off a release, then deploy from the webhook

Add your approval on the release, set job roles in Team settings, and configure a deploy webhook for the roles and people who must sign off.

Start a 14-day free trial · Book a demo

FAQ

Who can approve a release?

Each signed-in project member can add and remove only their own approval. There is one approval per person per version.

Where is the job role set?

Organization admins set one job role per person in Team settings. The default is dev. The approval stores that role at approval time, so a later Team settings edit does not change history.

When does the deploy webhook fire?

Once when the required roles and people flip from unmet to met. Extra approvals after that do not fire again. An empty required list never fires. Retries use the same delivery id.