Skip to main content
Webhooks allow you to receive real-time notifications about test events. Configure your webhook URL, shared secret, and event subscriptions in your company settings. Screenshot 2025-07-18 at 3.46.46 PM.png

Supported Events

  • Test Group Run Passed: All tests in the group completed successfully
  • Test Group Run Failed: One or more tests failed or encountered errors
  • Test Group Run Stopped: Test group run was manually stopped

Security & Verification

All requests are signed with HMAC-SHA256. The X-Docket-Signature header contains:
To verify:
  1. Extract timestamp t and signature s from the header
  2. Create signed payload: {timestamp}.{raw_request_body}
  3. Compute HMAC-SHA256 using the shared webhook secret
  4. Compare with provided signature

Payload Schema

Key Fields

  • event: Event type (test_group_run_passed, test_group_run_failed, test_group_run_stopped)
  • payload.status: Test group status (passed, failed, stopped)
  • payload.tests: Array of individual test results
  • payload.tests_*: Count of tests by status
  • payload.github_context: GitHub context information (only present during CI/CD runs)
    • ref: Git reference (branch/tag)
    • commit_sha: Commit SHA hash
    • repository: Repository name

Requirements

  • Respond with HTTP 200-204 within 10 seconds
  • Use HTTPS endpoints only
  • Handle duplicate deliveries using X-Docket-Idempotency-Key header