Workflows
Last updated
Last updated
Use these operations to interact with in Cortex.
View Workflows: Your API key must have the View Workflows
permission.
Create or update Workflows: Your API key must have the Edit Workflows
permission.
Callback a paused async HTTP block: Your API key must have Edit Workflow Runs
permission.
List workflows.
API key must have the View workflows
permission.
When true, returns the list of actions for each workflow. Defaults to false.
false
When 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.
250
Page number to return, 0-indexed. Default 0.
0
Successfully found workflows
Retrieve workflow by tag or ID.
API key must have the View workflows
permission.
The tag or unique, auto-generated identifier for the workflow.
Successfully found workflow
Delete workflow by tag or ID.
API key must have the Edit workflows
permission.
The tag or unique, auto-generated identifier for the workflow.
Workflow deleted successfully
No content
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.
List of actions in the workflow
Description of the workflow
Filter to determine in what entity contexts the workflow can run
Icon tag for the workflow
Whether the workflow is a draft
Name of the workflow
Template for the response when the workflow is run
List of restriction policies for the workflow
Tag of the workflow
Workflow created successfully
Updates an asynchronous HTTP request Workflow block.
API key must have the Edit workflow runs
permission.
The tag or unique, auto-generated identifier for the workflow.
Callback ID; Provided by the Workflow block when it runs
Human readable message to be shown to the user
Response from the callback request. If set, must be a JSON object
Status of the callback request. UPDATE
keeps the workflow paused
SUCCESS
FAILURE
UPDATE
Successfully received Workflow callback
No content