Skip to content
API ReferenceDoc

Processes API

Create and manage process definitions, triggers, and executions.

Processes define suites: which tests to include (tags), schedules, and triggers.

With an API key, reading processes and their triggers needs the execution:read scope. Creating or changing a process, its triggers or its automation needs platform:manage.

Custom process payload

When creating a custom process (isSystem: false), send:

  • name (required)
  • kind (suite or agent)
  • goal (required)
  • configuration.testCaseTags (optional)

Custom processes are manual-only today:

  • server ignores custom schedule/triggers and stores manual behavior
  • memory is disabled and not configurable

List processes

GET/api/projects/{projectId}/processesBearer Token

Overview (UI)

GET/api/projects/{projectId}/processes/overviewBearer Token

Create process

POST/api/projects/{projectId}/processesBearer Token

Get process

GET/api/projects/{projectId}/processes/{idOrSlug}Bearer Token

Update process

PUT/api/projects/{projectId}/processes/{idOrSlug}Bearer Token

Triggers

GET/api/projects/{projectId}/processes/{processId}/triggersBearer Token
PUT/api/projects/{projectId}/processes/{processId}/triggersBearer Token

Execute process (create a run)

POST/api/projects/{projectId}/processes/{processSlug}/execute?environmentId=...Bearer Token

environmentId is a query parameter and is required. The response has processRunId, itemCount and message. If the process already runs in that environment, you get 409. With an API key, this needs the process:execute scope.