Skip to main content

Published

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 attach a deploy webhook that TestChimp calls when every required role and every required person on that webhook 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.

Job role is a title for sign-off. It is not the TestChimp organization role (Admin or Viewer) and it is not chosen per project.

Deploy webhook​

Project settings → Release Approvals (/project-config?tab=release-approvals) holds one or more webhooks. Each webhook has:

FieldRequired
NicknameOptional. Nicknames must be unique when set.
URLYes. https only. TestChimp rejects URLs with embedded credentials and hosts that resolve to private, loopback, or link-local addresses.
Authorization headerOptional. Sent as Authorization when present.
Required rolesAt least one required role or one required person
Required peopleAt least one required role or one required person

A webhook runs when every required role and every required person has an approval on that version. A webhook with no required role and no required person never runs. Removing an approval does not call the webhook.

Each new approval that leaves the webhook's requirements met sends the POST again. Treat the receiver as idempotent: the same version can be delivered more than once.

On the release detail page, a banner offers Configure deploy webhook when nothing is saved. Closing the banner hides it for that project.

Payload​

Content-Type: application/json. Field names are camelCase.

{
"event": "release_approval_requirements_met",
"projectId": "<project id>",
"version": "1.2.3",
"gitCommitSha": "<sha>",
"triggeredByUserId": "<user id>",
"approvals": [
{
"userId": "<user id>",
"displayName": "Ada",
"role": "qa lead",
"createdTimestampMillis": 0
}
]
}

approvals lists everyone who has approved that version, with the role snapshotted on each approval. triggeredByUserId is the person whose new approval caused this delivery.

GitHub Actions​

There is no GitHub Actions picker in project settings. Point the webhook URL at a deploy hook you control.

GitHub Actions can listen with repository_dispatch or workflow_dispatch. Use a workflow that accepts this JSON body, or a small proxy that wraps it as client_payload for repository_dispatch.

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?

After an approval is added, each saved webhook whose required roles and required people are all present receives one POST. A webhook with neither a required role nor a required person never fires. The same conditions can fire again on a later approval, so the receiver should be idempotent.

Sign off a release, then deploy from the webhook

Add your approval on the release, set job roles in Team settings, and point a deploy webhook at 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?

After an approval is added, each saved webhook whose required roles and required people are all present receives one POST. A webhook with neither a required role nor a required person never fires. The same conditions can fire again on a later approval, so the receiver should be idempotent.