Webhooks are a new addition to Cypress Cloud, supporting more flexible automation workflows beyond what is built into the platform itself.
Learn why we've added them and how to get started using them in your project.
Integration support in Cypress Cloud
Cypress Cloud supports a wide range of integrations out of the box. If you need a GitHub status check for every group of tests in your test run, we've got you covered. Slack and Teams messages when a run fails? That's there, along with desktop notifications, Jira ticket creation, high-level trend reporting APIs, and more.
Why webhooks?
Using webhooks is a great solution for custom integrations where you want Cypress Cloud to push run results and other data into another system.
A webhook can be the starting point to kick off workflows based on inspecting the outcome of a run, or a way to customize the details you will include in a Slack or Teams message, or send messages to destinations Cypress doesn't support, such as Google Chat.
Webhooks also help you leverage our other recently-released Cypress App and Cypress Cloud updates in ways that work for you. Rather than invoke the Cypress Cloud CLI or MCP at the end of every run, you can set up a URL for Cypress to deliver run results, along with the tags, branch, and commit info that helps you decided if further action is needed.
This lets you be more efficient with AI token usage and reduce rate-limited request you make for routine run analysis. Filter to just the runs you are most interested in based on the webhook payload, then you can dive deeper with scripts using the Cloud AI tools to get Test Replay snapshot data and command logs, or hand off to your LLM using the live Cypress App running locally with cypress tap.
When to use a webhook
In some cases, existing APIs may fully meet your needs, particularly if your runs are small and the existing integrations are well-suited to the content you already want in your messaging platforms.
In other cases, webhooks remove multiple layers of handoffs from your CI environment to other services, removing glue code or even opening up new possibilities, like optionally triggering re-runs of your failed tests in CI based on the tags or commit message you send to Cypress Cloud.
Get started
Available on all paid Cypress Cloud plans, today webhooks can be attached to a run.completed event, which fires when a run has resolved to a finalized state after all results have been recorded.
Admins and owners can add webhooks in your project settings page.
Note: the recently-released Run Completion API may be useful if you have parallel or grouped runs, and you want your webhooks to fire as soon as all expected groups have finished recording.
What's next
We'd love to know how you are using this and what types of events or payloads would be useful for your specific goals. We will continue developing and expanding in this area based on your feedback.
Read the webhooks docs to get your first webhook configured. Don't have a Cypress Cloud account yet? Start your free trial and try it on your own project.