How can I run end-to-end tests after my Vercel Preview Deployment?

You can run an end-to-end test suite after your Vercel deployment has finished with the following methods:

• Using GitHub Actions' repository_dispatch events
• Using webhooks with other CI providers

If your project has Deployment Protection enabled, ensure you use Protection Bypass for Automation so your test environments can reach your deployments.

Copy link to headingUsing GitHub Actions' repository_dispatch events

1. Connect your Git repository to your project. For new projects, you can follow these docs. For existing projects, visit your Git configuration in the Settings tab of your project dashboard.
2. Create a GitHub workflow in .github/workflows with the following:

name: Playwright Tests

on:
  repository_dispatch:
    types:
      - 'vercel.deployment.success'
jobs:
  run-e2es:
    if: github.event_name == 'repository_dispatch'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          ref: ${{ github.event.client_payload.git.sha }}
      - name: Install dependencies
        run: npm ci && npx playwright install --with-deps
      - name: Run tests
        run: npx playwright test
        env:
          BASE_URL: ${{ github.event.client_payload.url }}

Copy link to headingUsing webhooks for other CI providers

1. Configure a webhook for the deployment.succeeded event.
2. Listen for the webhook to trigger your CI workflow.
3. Run end-to-end test suites.