Automation guide
GitHub Actions SEO check before every deploy
Stop shipping SEO regressions. Queue a property crawl from your workflow, poll job status, and fail the build when the scan does not complete cleanly.
Customer workflow
“We gate every production deploy on a XenonFlare scan. Idempotency-Key tied to the commit SHA means reruns never double-queue, and failed jobs block merge until we fix canonical or redirect regressions.”
SaaS platform team using Developer API in GitHub Actions
- PR + main workflows
- Idempotency-Key per SHA
- Fail on job.failed webhook
Setup checklist
- Add secrets for your XenonFlare API key and property ID
- Copy the workflow from the CI pipeline documentation
- Run on pull_request and push to main with different crawl depth
- Fail the job when status is failed or cancelled
- Optional: notify Slack when score drops below your threshold
What you get
- Store XF_API_KEY and XF_PROPERTY_ID as GitHub secrets
- Use Idempotency-Key: ci-${{ github.sha }} to prevent duplicate jobs
- Cap maxPages/maxDepth for faster PR checks; full scans on main
- Echo X-Request-Id for support correlation
- Same REST endpoints as any integration — not a separate product
FAQ
- Do I need a paid plan?
- Yes. Developer API keys require Starter or Growth. Free tier workspaces cannot create API keys.
- Will every PR enqueue a full 100k-page crawl?
- No — pass lower maxPages and maxDepth in the POST body for PR builds. Reserve full crawls for main branch nightly jobs.
- Where is the full workflow YAML?
- The complete GitHub Actions example lives in the CI pipeline guide under Documentation.
Start on the Free plan
No credit card required. Upgrade when you need unlimited scans, AI fixes, or higher crawl limits.
Get started