HTTP Webhooks
HTTP Webhooks for Cypress tests dashboard

Description

Enabling HTTP Webhook Integration will trigger an HTTP POST request to an endpoint of your choice.
Currents will send a POST request for the following lifecycle event of cypress tests run:
  • a new cypress tests run starts
  • a run finishes
  • a runs times out
  • a run is cancelled
Please note: The endpoint should be publicly accessible

Examples

Example of HTTP POST request with cypress tests run data

curl --location --request POST 'https://yourserver.com/webhook/currents.dev' \
--header 'Content-Type: application/json' \
--data-raw '{
"event": "RUN_START",
"runUrl": "https://app.currents.dev/run/950a13c3edf4f28b6e8ce301a404b4aa",
"buildId": "demo-build-cdx3314",
"commit": {
"authorEmail": "[email protected]",
"authorName": "John Doe",
"defaultBranch": "main",
"branch": "feature-A",
"message": "feat: change button color",
"remoteOrigin": "https://github.com/org/repo.git",
"sha": "5a7edc9a156e417068060d67109021351fc7d9b8"
},
"failures": 0,
"flaky": 0,
"overall": 1,
"passes": 1,
"pending": 0,
"retries": 0,
"skipped": 0
}'

HTTP Webhook Integration payload schema

{
event: "RUN_START" | "RUN_FINISH" | "RUN_TIMEOUT" | "RUN_CANCELED";
runUrl: string; // currents dashoard run URL
buildId: string; // as reported by CI
groupId: string; // only for multigroup runs
tags: string[];
commit: {
sha: string | null;
branch: string | null;
authorName: string | null;
authorEmail: string | null;
message: string | null;
remoteOrigin: string | null;
defaultBranch: string | null;
},
overall: number; // overall number of tests
passes: number; // number of passed tests
failures: number; // number of failed tests
pending: number; // number of pending tests
skipped: number; // number of skipped tests
retries: number; // number of test retries for the run
flaky: number; // number of flaky tests for the run
}
Copy link
On this page
Description
Examples