Skip to content

Create a new Pipeline
Stable

Request

Creates a new Pipeline for the calling enterprise, using the logged-in user's token.

Requires a name in the request body; optional fields include description, is_default (default false), is_active (default true), and timeout_seconds (default 86400, i.e. 24 hours). Returns the created Pipeline object.

About Pipelines

A Pipeline is the top-level container in Esper's Pipelines system for orchestrating multi-step device operations. It's made up of ordered Stages, each with its own Target Lists (devices and/or Device Groups) and Operation Lists (the actions to perform); executing a Pipeline produces a Pipeline Run that tracks progress through statuses such as PENDING, QUEUED, PROCESSING, RUNNING, WAITING, COMPLETE, and finally SUCCESS or FAILURE.

Key Fields / Query Parameters

  • name — required pipeline name
  • timeout_seconds — overall timeout for runs of this pipeline, in seconds, default 86400
  • is_default — marks this as the enterprise's default pipeline, default false
  • is_active — whether the pipeline is active, default true
Security
pipelines_SCAPIAuthToken
Bodyapplication/jsonrequired
namestringrequired
descriptionstring
is_defaultboolean
Default:false
is_activeboolean
Default:true
timeout_secondsnumber, (int32)
Default:86400
cURL
curl -i -X POST \
  https://api.esper.io/_mock/openapi/pipelines/v0/pipelines/ \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "is_default": false,
    "is_active": true,
    "timeout_seconds": 86400
  }'

Responses

Created

Bodyapplication/json
codeinteger
messagestring
contentobject(pipelines_Pipeline)
Response
{
  "code": 0,
  "message": "string",
  "content": {
    "id": "string",
    "enterprise_id": "string",
    "name": "string",
    "description": "string",
    "is_active": true,
    "is_valid": true,
    "is_visible": true,
    "is_archived": true,
    "is_default": true,
    "timeout_seconds": 0,
    "created_by": 0,
    "updated_by": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}