For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Discord
DocsAPI Reference
DocsAPI Reference
  • Get Started
    • Welcome
    • Introduction
    • Quick Start
  • Run
    • Run Videos
    • Run Mode
    • Viewport Size
    • Preparation Test
    • Pull Request Testing
    • Production Monitoring
    • Group Webhooks
    • Run Troubleshooting
  • Auth
    • Test Credentials
    • API Keys
    • Agent Mail Inboxes
    • HTTP Basic Auth
    • Auth Troubleshooting
  • Mobile
    • Overview
    • App Uploads
    • Expo EAS
    • GitHub Actions
  • Integrations
    • Vercel
    • Coolify
    • Custom Infrastructure
    • Slack
    • Discord
    • Email
  • Guides
    • Testing Staging Environment
  • CLI
    • Getting Started
    • Local Development
    • Agentic Usage
  • AI
    • LLMs
LogoLogo
Discord
On this page
  • Prerequisites
  • 1. Create a test group webhook
  • 2. Trigger after deployment
  • GitHub Actions
  • 3. View results
  • How commitSha works
  • Troubleshooting
  • No check run appears on GitHub
  • Tests run against the wrong URL
Guides

Testing Staging Environment

||View as Markdown|
Was this page helpful?
Edit this page
Previous

Email

Next

Getting Started

Built with

This guide walks through testing a staging environment deployed on your own infrastructure. You’ll use group webhooks with a commitSha to trigger tests after deployment and get results as GitHub commit check runs.

Prerequisites

  • GitHub App installed and connected to your repository.
  • A project with tests organized in a group.

1. Create a test group webhook

  1. Open your project → Tests tab.
  2. Expand the group you want to run against staging.
  3. Click the trigger badge (lightning icon).
  4. Toggle Enable webhook on and click Save.
  5. Copy the webhook URL - the secret is shown once.

The URL looks like:

https://tester.army/api/v1/groups/webhook/{id}/{secret}

See Group Webhooks for more details.

2. Trigger after deployment

Once your staging deployment completes, call the webhook with the commit SHA. This links test results to the commit on GitHub as a check run.

GitHub Actions

Add a step after your deployment job:

1- name: Run TesterArmy tests
2 run: |
3 curl -X POST "${{ secrets.TESTERARMY_WEBHOOK_URL }}" \
4 -H "Content-Type: application/json" \
5 -d "{\"commitSha\":\"${{ github.sha }}\",\"targetUrl\":\"${{ secrets.TESTERARMY_TARGET_URL }}\",\"environment\":\"staging\"}"

Add these to your repository secrets (Settings -> Secrets and variables -> Actions):

  • TESTERARMY_WEBHOOK_URL - the full webhook URL including the secret.
  • TESTERARMY_TARGET_URL - staging environment URL (e.g. https://staging.myapp.com).

targetUrl is optional - if omitted, tests run against the URL configured in your project settings. Include environment: "staging" so these runs show under the Staging filter in results. Runs with targetUrl default to PR Preview when environment is omitted.

3. View results

When tests finish, results appear in two places:

  • GitHub - a commit check run on the SHA, visible in the PR checks tab.
  • TesterArmy dashboard - full run details with screenshots and logs.

How commitSha works

Without commitSha, TesterArmy runs the tests but has no way to report back to GitHub. Passing it enables the integration:

  1. Tests are queued against targetUrl when provided, otherwise the project’s configured URL.
  2. A pending check run is created on the commit.
  3. When tests complete, the check run updates with the batch summary.

Troubleshooting

No check run appears on GitHub

  1. GitHub App not connected - verify installation in Project Settings.
  2. Missing commitSha - the webhook still runs tests, but can’t post results to GitHub without it.
  3. Permissions - the GitHub App needs Checks: Read & Write.

Tests run against the wrong URL

Tests run against targetUrl if provided in the webhook body, otherwise the URL configured in your project settings. Make sure one of them points to your staging environment.