ReleaseReady Docs

Practical implementation guidance for Playwright JavaScript/TypeScript teams.

Core Flows

Webhooks

How GitHub pull request webhooks trigger runs and how signatures are verified.

Webhooks

ReleaseReady supports GitHub webhook ingestion for pull request activity.

Supported PR trigger actions

The webhook flow triggers project runs for these pull_request actions:

  • opened
  • reopened
  • synchronize
  • ready_for_review

How webhook verification works

ReleaseReady verifies the GitHub signature with the project-specific webhook secret when available.

If a project-specific secret is not available, ReleaseReady can fall back to GITHUB_WEBHOOK_SECRET from the environment.

This preserves compatibility for older and newer integration records.

Project mapping behavior

ReleaseReady tries to resolve the project using the projectId query parameter on the webhook URL.

If needed, it can also use GitHub repository metadata stored on the integration record.

  1. In your GitHub repository, open **Settings → Webhooks**.
  2. Add the ReleaseReady project webhook URL.
  3. Paste the ReleaseReady webhook secret.
  4. Subscribe to pull request events.

Important notes

  • Keep the webhook URL project-specific.
  • If GitHub sends application/x-www-form-urlencoded, ReleaseReady still parses the payload field correctly.
  • If signature verification fails, the webhook is rejected.

Continue