Workflows
Required permissions
Operations
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
When true, returns the list of actions for each workflow. Defaults to false.
falseWhen set, only returns workflows with the given substring in the name or description.
Number of results to return per page, between 1 and 1000. Default 250.
250Page number to return, 0-indexed. Default 0.
0Successfully found workflows
Current page number, 0-indexed
Total number of results
Total number of pages
Access denied
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
GET /api/v1/workflows?pageSize=250&page=0 HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"page": 1,
"total": 1,
"totalPages": 1,
"workflows": [
{
"actions": [
{
"isRootAction": true,
"name": "text",
"outgoingActions": [
"text"
],
"schema": {
"type": "text",
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"httpMethod": "GET",
"integration": "AzureDevops",
"integrationAlias": "text",
"payload": "text",
"url": "text"
},
"slug": "text"
}
],
"createdAt": "text",
"createdBy": {
"email": "cristina@cortex.io",
"name": "Cristina Buenahora"
},
"description": "text",
"failedRunResponseTemplate": "text",
"filter": {
"type": "GLOBAL"
},
"iconTag": "text",
"isDraft": true,
"isRunnableViaApi": true,
"lastUpdatedAt": "text",
"lastUpdatedBy": {
"email": "cristina@cortex.io",
"name": "Cristina Buenahora"
},
"name": "text",
"restrictActionCompletionToRunnerUser": true,
"runResponseTemplate": "text",
"runRestrictionPolicies": [
{
"id": "text",
"type": "USER"
}
],
"tag": "text",
"variables": [
{
"defaultValue": {},
"description": "text",
"slug": "text",
"type": "STRING"
}
]
}
]
}All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Entity identifier - can be a tag or CID
Successfully found workflow
The date the workflow was created, in ISO 8601 format
Description of the workflow
Template for the response when the workflow run fails
Icon tag for the workflow
Whether the workflow is a draft
Whether the workflow is runnable via the public API
The date the workflow was last updated, in ISO 8601 format
Name of the workflow
If true, only the user who started the workflow can complete actions. Defaults to false.
Template for the response when the workflow is completed successfully
Tag of the workflow
Access denied
Workflow not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
GET /api/v1/workflows/{tagOrId} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"actions": [
{
"isRootAction": true,
"name": "text",
"outgoingActions": [
"text"
],
"schema": {
"type": "text",
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"httpMethod": "GET",
"integration": "AzureDevops",
"integrationAlias": "text",
"payload": "text",
"url": "text"
},
"slug": "text"
}
],
"createdAt": "text",
"createdBy": {
"email": "cristina@cortex.io",
"name": "Cristina Buenahora"
},
"description": "text",
"failedRunResponseTemplate": "text",
"filter": {
"type": "GLOBAL"
},
"iconTag": "text",
"isDraft": true,
"isRunnableViaApi": true,
"lastUpdatedAt": "text",
"lastUpdatedBy": {
"email": "cristina@cortex.io",
"name": "Cristina Buenahora"
},
"name": "text",
"restrictActionCompletionToRunnerUser": true,
"runResponseTemplate": "text",
"runRestrictionPolicies": [
{
"id": "text",
"type": "USER"
}
],
"tag": "text",
"variables": [
{
"defaultValue": {},
"description": "text",
"slug": "text",
"type": "STRING"
}
]
}All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
The date the workflow was created, in ISO 8601 format
Description of the workflow
Template for the response when the workflow run fails
Icon tag for the workflow
Whether the workflow is a draft
Whether the workflow is runnable via the public API
The date the workflow was last updated, in ISO 8601 format
Name of the workflow
If true, only the user who started the workflow can complete actions. Defaults to false.
Template for the response when the workflow is completed successfully
Tag of the workflow
Workflow created successfully
The date the workflow was created, in ISO 8601 format
Description of the workflow
Template for the response when the workflow run fails
Icon tag for the workflow
Whether the workflow is a draft
Whether the workflow is runnable via the public API
The date the workflow was last updated, in ISO 8601 format
Name of the workflow
If true, only the user who started the workflow can complete actions. Defaults to false.
Template for the response when the workflow is completed successfully
Tag of the workflow
Bad request
Access denied
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
POST /api/v1/workflows HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 830
{
"actions": [
{
"isRootAction": true,
"name": "text",
"outgoingActions": [
"text"
],
"schema": {
"type": "text",
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"httpMethod": "GET",
"integration": "AzureDevops",
"integrationAlias": "text",
"payload": "text",
"url": "text"
},
"slug": "text"
}
],
"createdAt": "text",
"createdBy": {
"email": "cristina@cortex.io",
"name": "Cristina Buenahora"
},
"description": "text",
"failedRunResponseTemplate": "text",
"filter": {
"type": "GLOBAL"
},
"iconTag": "text",
"isDraft": true,
"isRunnableViaApi": true,
"lastUpdatedAt": "text",
"lastUpdatedBy": {
"email": "cristina@cortex.io",
"name": "Cristina Buenahora"
},
"name": "text",
"restrictActionCompletionToRunnerUser": true,
"runResponseTemplate": "text",
"runRestrictionPolicies": [
{
"id": "text",
"type": "USER"
}
],
"tag": "text",
"variables": [
{
"defaultValue": {},
"description": "text",
"slug": "text",
"type": "STRING"
}
]
}{
"actions": [
{
"isRootAction": true,
"name": "text",
"outgoingActions": [
"text"
],
"schema": {
"type": "text",
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"httpMethod": "GET",
"integration": "AzureDevops",
"integrationAlias": "text",
"payload": "text",
"url": "text"
},
"slug": "text"
}
],
"createdAt": "text",
"createdBy": {
"email": "cristina@cortex.io",
"name": "Cristina Buenahora"
},
"description": "text",
"failedRunResponseTemplate": "text",
"filter": {
"type": "GLOBAL"
},
"iconTag": "text",
"isDraft": true,
"isRunnableViaApi": true,
"lastUpdatedAt": "text",
"lastUpdatedBy": {
"email": "cristina@cortex.io",
"name": "Cristina Buenahora"
},
"name": "text",
"restrictActionCompletionToRunnerUser": true,
"runResponseTemplate": "text",
"runRestrictionPolicies": [
{
"id": "text",
"type": "USER"
}
],
"tag": "text",
"variables": [
{
"defaultValue": {},
"description": "text",
"slug": "text",
"type": "STRING"
}
]
}All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Validation result
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
POST /api/v1/workflows/validate HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6
"text"{
"ok": true,
"violations": [
{
"description": "text",
"endLine": 1,
"paths": [
"text"
],
"pointer": "text",
"ruleLink": "text",
"startLine": 1,
"title": "text",
"violationType": "MUST"
}
]
}All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Entity identifier - can be a tag or CID
Callback ID; Provided by the Workflow block when it runs
Human readable message to be shown to the user
Status of the callback request. UPDATE keeps the workflow paused
Successfully received Workflow callback
No content
Bad request
Access denied
Workflow run or block not found
Workflow block is not waiting for callback
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
POST /api/v1/workflows/{tagOrId}/callback/{callbackId} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79
{
"message": "text",
"response": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"status": "SUCCESS"
}No content
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Entity identifier - can be a tag or CID
Workflow deleted successfully
No content
Workflow not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
DELETE /api/v1/workflows/{tagOrId} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Entity identifier - can be a tag or CID
List of email addresses to notify of workflow updates.
User's email to run the workflow as
Workflow run started successfully
Time the workflow run completed
Id of the run
Time the workflow run started
Status of the workflow run
Access denied or running workflow is disabled
Workflow not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
POST /api/v1/workflows/{tagOrId}/runs HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 168
{
"initialContext": {},
"notificationRecipients": [
"text"
],
"runAs": "text",
"scope": {
"itemType": "text",
"archived": true,
"cid": "text",
"name": "text",
"tag": "text",
"type": "text"
}
}{
"actions": [
{
"completedAt": "text",
"isRootAction": true,
"name": "text",
"outgoingActions": [
"text"
],
"schema": {
"type": "text",
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"httpMethod": "GET",
"integration": "AzureDevops",
"integrationAlias": "text",
"payload": "text",
"url": "text"
},
"slug": "text",
"startedAt": "text",
"state": {
"inputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"metadata": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"status": "NOT_INITIATED",
"variables": {
"ANY_ADDITIONAL_PROPERTY": {}
}
}
}
],
"completedAt": "text",
"context": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"id": "text",
"initiatedBy": {
"type": "text",
"apiKey": {
"id": "text",
"last4": "text",
"name": "text",
"type": "text"
}
},
"runResponse": "text",
"startedAt": "text",
"status": "text",
"variables": {
"ANY_ADDITIONAL_PROPERTY": {
"type": "text",
"value": {}
}
},
"workflow": {
"cid": "text",
"name": "text"
}
}All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Entity identifier - can be a tag or CID
Successfully found workflow run
Time the workflow run completed
Id of the run
Time the workflow run started
Status of the workflow run
Workflow or run not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
GET /api/v1/workflows/{tagOrId}/runs/{runId} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"actions": [
{
"completedAt": "text",
"isRootAction": true,
"name": "text",
"outgoingActions": [
"text"
],
"schema": {
"type": "text",
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"httpMethod": "GET",
"integration": "AzureDevops",
"integrationAlias": "text",
"payload": "text",
"url": "text"
},
"slug": "text",
"startedAt": "text",
"state": {
"inputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"metadata": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"status": "NOT_INITIATED",
"variables": {
"ANY_ADDITIONAL_PROPERTY": {}
}
}
}
],
"completedAt": "text",
"context": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"id": "text",
"initiatedBy": {
"type": "text",
"apiKey": {
"id": "text",
"last4": "text",
"name": "text",
"type": "text"
}
},
"runResponse": "text",
"startedAt": "text",
"status": "text",
"variables": {
"ANY_ADDITIONAL_PROPERTY": {
"type": "text",
"value": {}
}
},
"workflow": {
"cid": "text",
"name": "text"
}
}All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Successfully found workflow runs
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
GET /api/v1/workflows/runs?workflowRunQuery=[object+Object]&pageable=[object+Object] HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"hasMore": true,
"items": [
{
"completedAt": "text",
"context": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"id": "text",
"initiatedBy": {
"type": "text",
"apiKey": {
"id": "text",
"last4": "text",
"name": "text",
"type": "text"
}
},
"runResponse": "text",
"startedAt": "text",
"status": "text",
"variables": {
"ANY_ADDITIONAL_PROPERTY": {
"type": "text",
"value": {}
}
},
"workflow": {
"cid": "text",
"name": "text"
}
}
],
"page": 1,
"total": 1,
"totalCapped": true,
"totalPages": 1
}Last updated
Was this helpful?