Workflows

Use these operations to interact with Workflows in Cortex.

Required permissions

• View Workflows: Your API key must have the View Workflows permission.

• Create or update Workflows: Your API key must have the Edit Workflows permission.

Operations

List workflows

get

List workflows.

API key must have the View workflows permission.

Authorizations

Query parameters

includeActionsboolean · default: falseoptional

When true, returns the list of actions for each workflow. Defaults to false.

searchQuerystringoptional

When set, only returns workflows with the given substring in the name or description.

pageSizeinteger · int32 · default: 250required

Number of results to return per page, between 1 and 1000. Default 250.

pageinteger · int32 · default: 0required

Page number to return, 0-indexed. Default 0.

Responses

application/jsonapplication/yaml

application/jsonapplication/yaml

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/workflows?pageSize=1&page=1' \
  --header 'Authorization: Bearer JWT'

200

403

429

200

application/json

application/yaml

application/json

{
  "page": 1,
  "total": 1,
  "totalPages": 1,
  "workflows": [
    {
      "actions": [
        {
          "isRootAction": true,
          "name": "text",
          "outgoingActions": [
            "text"
          ],
          "schema": {
            "type": "text",
            "headers": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "httpMethod": "GET",
            "payload": "text",
            "url": "text"
          },
          "slug": "text"
        }
      ],
      "description": "text",
      "filter": {
        "type": "GLOBAL"
      },
      "iconTag": "text",
      "isDraft": true,
      "name": "text",
      "runResponseTemplate": "text",
      "runRestrictionPolicies": [
        {
          "id": "text",
          "type": "USER"
        }
      ],
      "tag": "text"
    }
  ]
}

Successfully found workflows

Retrieve workflow

get

Retrieve workflow by tag or ID.

API key must have the View workflows permission.

Authorizations

Path parameters

tagOrIdstringrequired

The tag or unique, auto-generated identifier for the workflow.

Responses

application/jsonapplication/yaml

application/jsonapplication/yaml

application/jsonapplication/yaml

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/workflows/{tagOrId}' \
  --header 'Authorization: Bearer JWT'

200

403

404

429

200

application/json

application/yaml

application/json

{
  "actions": [
    {
      "isRootAction": true,
      "name": "text",
      "outgoingActions": [
        "text"
      ],
      "schema": {
        "type": "text",
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "httpMethod": "GET",
        "payload": "text",
        "url": "text"
      },
      "slug": "text"
    }
  ],
  "description": "text",
  "filter": {
    "type": "GLOBAL"
  },
  "iconTag": "text",
  "isDraft": true,
  "name": "text",
  "runResponseTemplate": "text",
  "runRestrictionPolicies": [
    {
      "id": "text",
      "type": "USER"
    }
  ],
  "tag": "text"
}

Successfully found workflow

Create or update workflow

post

Create or update new workflow.

API key must have the Edit workflows permission.

Note: If a workflow with the same tag already exists, it will be updated.

Authorizations

Body

application/jsonapplication/yaml

actionsobject[]required

List of actions in the workflow

descriptionstringoptional

Description of the workflow

filterone ofrequired

Filter to determine in what entity contexts the workflow can run

iconTagstringoptional

Icon tag for the workflow

isDraftbooleanrequired

Whether the workflow is a draft

namestringrequired

Name of the workflow

runResponseTemplatestringoptional

Template for the response when the workflow is run

runRestrictionPoliciesobject[]optional

List of restriction policies for the workflow

tagstringrequired

Tag of the workflow

Responses

application/jsonapplication/yaml

application/jsonapplication/yaml

application/jsonapplication/yaml

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/workflows' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "actions": [
      {
        "isRootAction": true,
        "name": "text",
        "outgoingActions": [
          "text"
        ],
        "schema": {
          "type": "text",
          "headers": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "httpMethod": "GET",
          "payload": "text",
          "url": "text"
        },
        "slug": "text"
      }
    ],
    "description": "text",
    "filter": {
      "type": "GLOBAL"
    },
    "iconTag": "text",
    "isDraft": true,
    "name": "text",
    "runResponseTemplate": "text",
    "runRestrictionPolicies": [
      {
        "id": "text",
        "type": "USER"
      }
    ],
    "tag": "text"
  }'

application/jsonapplication/yaml

200

400

403

429

200

application/json

application/yaml

application/json

{
  "actions": [
    {
      "isRootAction": true,
      "name": "text",
      "outgoingActions": [
        "text"
      ],
      "schema": {
        "type": "text",
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "httpMethod": "GET",
        "payload": "text",
        "url": "text"
      },
      "slug": "text"
    }
  ],
  "description": "text",
  "filter": {
    "type": "GLOBAL"
  },
  "iconTag": "text",
  "isDraft": true,
  "name": "text",
  "runResponseTemplate": "text",
  "runRestrictionPolicies": [
    {
      "id": "text",
      "type": "USER"
    }
  ],
  "tag": "text"
}

Workflow created successfully

Delete workflow

delete

Delete workflow by tag or ID.

API key must have the Edit workflows permission.

Authorizations

Path parameters

tagOrIdstringrequired

The tag or unique, auto-generated identifier for the workflow.

Responses

application/jsonapplication/yaml

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.getcortexapp.com/api/v1/workflows/{tagOrId}' \
  --header 'Authorization: Bearer JWT'

200

404

429

200

No body

Workflow deleted successfully