Webhooks

Manage HTTP webhooks for projects.

Webhooks allow you to receive HTTP POST notifications when certain events occur in your test runs:

• RUN_FINISH: Run completed (passed or failed)

• RUN_START: Run started

• RUN_TIMEOUT: Run timed out

• RUN_CANCELED: Run was cancelled

Webhooks are useful for integrating with external tools like n8n, Zapier, or custom automation platforms.

List webhooks

get

https://api.currents.dev/v1https://api-staging.currents.dev/v1http://localhost:4000/v1

/webhooks

Get all generic webhooks for a project

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication using Bearer token

Query parameters

projectIdstringRequired

The project ID

Example: proj_abc123

Responses

200

List of webhooks

application/json

400

Invalid request parameters

application/json

401

Authentication failed

application/json

404

Resource not found

application/json

get

/webhooks

HTTPcURLJavaScriptPython

GET /v1/webhooks?projectId=text HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "OK",
  "data": [
    {
      "hookId": "123e4567-e89b-12d3-a456-426614174000",
      "projectId": "text",
      "url": "https://example.com",
      "headers": "text",
      "hookEvents": [
        "RUN_FINISH"
      ],
      "label": "text",
      "createdAt": "2026-01-23T04:34:05.730Z",
      "updatedAt": "2026-01-23T04:34:05.730Z"
    }
  ]
}

Create webhook

post

https://api.currents.dev/v1https://api-staging.currents.dev/v1http://localhost:4000/v1

/webhooks

Create a new generic webhook for a project

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication using Bearer token

Query parameters

projectIdstringRequired

The project ID

Example: proj_abc123

Body

application/json

urlstring · uri · max: 2048Required

URL to send webhook POST requests to

headersstring | nullableOptional

Custom headers as a JSON object string (e.g., {"Authorization": "Bearer token"})

labelstring | nullableOptional

Human-readable label for the webhook

Responses

201

Webhook created

application/json

400

Invalid request parameters

application/json

401

Authentication failed

application/json

404

Resource not found

application/json

post

/webhooks

HTTPcURLJavaScriptPython

POST /v1/webhooks?projectId=text HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "url": "https://example.com",
  "headers": "text",
  "hookEvents": [
    "RUN_FINISH"
  ],
  "label": "text"
}

{
  "status": "OK",
  "data": {
    "hookId": "123e4567-e89b-12d3-a456-426614174000",
    "projectId": "text",
    "url": "https://example.com",
    "headers": "text",
    "hookEvents": [
      "RUN_FINISH"
    ],
    "label": "text",
    "createdAt": "2026-01-23T04:34:05.730Z",
    "updatedAt": "2026-01-23T04:34:05.730Z"
  }
}

Get webhook

get

https://api.currents.dev/v1https://api-staging.currents.dev/v1http://localhost:4000/v1

/webhooks/{hookId}

Get a specific webhook by ID. The hookId is globally unique, so projectId is not required.

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication using Bearer token

Path parameters

hookIdstring · uuidRequired

The webhook ID (UUID)

Example: 550e8400-e29b-41d4-a716-446655440000

Responses

200

Webhook details

application/json

400

Invalid request parameters

application/json

401

Authentication failed

application/json

404

Resource not found

application/json

get

/webhooks/{hookId}

HTTPcURLJavaScriptPython

GET /v1/webhooks/{hookId} HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "OK",
  "data": {
    "hookId": "123e4567-e89b-12d3-a456-426614174000",
    "projectId": "text",
    "url": "https://example.com",
    "headers": "text",
    "hookEvents": [
      "RUN_FINISH"
    ],
    "label": "text",
    "createdAt": "2026-01-23T04:34:05.730Z",
    "updatedAt": "2026-01-23T04:34:05.730Z"
  }
}

Update webhook

put

https://api.currents.dev/v1https://api-staging.currents.dev/v1http://localhost:4000/v1

/webhooks/{hookId}

Update an existing webhook. Supports partial updates. The hookId is globally unique, so projectId is not required.

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication using Bearer token

Path parameters

hookIdstring · uuidRequired

The webhook ID (UUID)

Example: 550e8400-e29b-41d4-a716-446655440000

Body

application/json

urlstring · uri · max: 2048Optional

URL to send webhook POST requests to

headersstring | nullableOptional

Custom headers as a JSON object string (e.g., {"Authorization": "Bearer token"})

labelstring | nullableOptional

Human-readable label for the webhook

Responses

200

Webhook updated

application/json

400

Invalid request parameters

application/json

401

Authentication failed

application/json

404

Resource not found

application/json

put

/webhooks/{hookId}

HTTPcURLJavaScriptPython

PUT /v1/webhooks/{hookId} HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "url": "https://example.com",
  "headers": "text",
  "hookEvents": [
    "RUN_FINISH"
  ],
  "label": "text"
}

{
  "status": "OK",
  "data": {
    "hookId": "123e4567-e89b-12d3-a456-426614174000",
    "projectId": "text",
    "url": "https://example.com",
    "headers": "text",
    "hookEvents": [
      "RUN_FINISH"
    ],
    "label": "text",
    "createdAt": "2026-01-23T04:34:05.730Z",
    "updatedAt": "2026-01-23T04:34:05.730Z"
  }
}

Delete webhook

delete

https://api.currents.dev/v1https://api-staging.currents.dev/v1http://localhost:4000/v1

/webhooks/{hookId}

Delete a webhook. The hookId is globally unique, so projectId is not required.

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication using Bearer token

Path parameters

hookIdstring · uuidRequired

The webhook ID (UUID)

Example: 550e8400-e29b-41d4-a716-446655440000

Responses

200

Webhook deleted

application/json

400

Invalid request parameters

application/json

401

Authentication failed

application/json

404

Resource not found

application/json

delete

/webhooks/{hookId}

HTTPcURLJavaScriptPython

DELETE /v1/webhooks/{hookId} HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "OK",
  "data": {
    "hookId": "123e4567-e89b-12d3-a456-426614174000",
    "projectId": "text"
  }
}