API Reference
Collections
Records
Workflows
- GETDiscover Workflows
- GETGet Discoverable Workflow
- GETGet Discoverable Workflow Version
- POSTRun Discoverable Workflow
- POSTCancel a Discoverable Workflow Run
- GETGet Workflows
- GETGet a Workflow
- GETGet Workflow Runs
- POSTRun a Workflow
- POSTReplay a Workflow Run
- GETGet a Workflow Run
- POSTCancel a Workflow Run
- GETGet Workflow Versions
- GETGet a Workflow Version
Tests
Variables
Create a Test
Create a new workflow test for a specific workflow.
Path Parameters
The ID of the app
The ID of the workflow
Query Parameters
all Body
Data to create a new workflow test
Name of the workflow test to be created (max 256 characters)
1 - 256Response
Detailed information about a workflow test
Creation date of the workflow test
Number of failing expectations
Number of passing expectations
Unique identifier for the workflow test
Name of the workflow test
Run details of the workflow test
ID of the associated app where the run was triggered from
Timestamp of when the run was created
Timestamp of when the run ended
Unique identifier for the run
Origin of the run
WORKFLOW, RECORD, TEST, ENDPOINT Output of the run
Detailed information about the step run
Key of the step run
1 - 128Status of the step run, must be RUNNING
RUNNING Output of the step run
ID of the app that this step belongs to
Error message if the step run failed
Origin of the step run
WORKFLOW, RECORD, TEST, ENDPOINT ID of the workflow run that ran this step
Status of the step run
PENDING, RUNNING, CANCELLED, COMPLETED, SKIPPED, FAILED ID of the app that the workflow belongs to
ID of the workflow
Output of the workflow step run
Result of the workflow step run
Credits usage of the step run
Timestamp of when the step run started
Timestamp of when the run started
Status of the run
PENDING, RUNNING, CANCELLED, COMPLETED, SKIPPED, FAILED Timestamp of when the run was last updated
ID of the associated app where the workflow belongs to
ID of the associated workflow
Details of the workflow version used for the run
App id where the workflow version belongs to
Date when the version was deployed
Description of the workflow at the time this version was deployed
Unique identifier for the workflow version
Input definition of the workflow
The file type allows users to upload files
The type of the input field
file Allowed mime types for the file field (e.g. image/*, application/pdf)
Indicates whether the input field can contain multiple values
Whether to make the field a configuration field (only visible in the configuration tab)
The description of the input field
10240Display options for the file field
Flag to extract contents from the file
Flag to extract images from the file
The name of the input field
1024Indicates whether the input field is optional
The order of the input field relative to other fields in the form
x > 0The placeholder of the input field
512Default config input values of the workflow
Input options of the workflow
Display options for the input fields
Controls how the field container behaves in terms of width and positioning
grid, full, center Controls how the label and input field are arranged (inline or stacked)
inline, stacked Indicates whether the input field is hidden from the UI
Unique key for the workflow version
Release notes
Steps of the workflow at the time this version was deployed
A unique key for the step
1 - 128The note content (markdown supported)
The type of the step
note A condition to determine if the step should run
The step keys that this step connects to
Whether the step is connected to the input
A loop condition for the step to repeat running until the condition is met
The position of the step on the canvas
The size of the step on the canvas
Whether to throw an error if the step fails
Version number
Workflow id where the version belongs to
Version number from which this version was rolled back
Draft version of the workflow
Input definition of the workflow
The file type allows users to upload files
The type of the input field
file Allowed mime types for the file field (e.g. image/*, application/pdf)
Indicates whether the input field can contain multiple values
Whether to make the field a configuration field (only visible in the configuration tab)
The description of the input field
10240Display options for the file field
Flag to extract contents from the file
Flag to extract images from the file
The name of the input field
1024Indicates whether the input field is optional
The order of the input field relative to other fields in the form
x > 0The placeholder of the input field
512Default config input values of the workflow
Input options of the workflow
Display options for the input fields
Controls how the field container behaves in terms of width and positioning
grid, full, center Controls how the label and input field are arranged (inline or stacked)
inline, stacked Indicates whether the input field is hidden from the UI
Unique key for the workflow version
Steps of the workflow at the time this version was deployed
A unique key for the step
1 - 128The note content (markdown supported)
The type of the step
note A condition to determine if the step should run
The step keys that this step connects to
Whether the step is connected to the input
A loop condition for the step to repeat running until the condition is met
The position of the step on the canvas
The size of the step on the canvas
Whether to throw an error if the step fails
ID of the associated collection
Error message if the run failed
ID of the associated record
Result of the run
Version number of the workflow
Status of the workflow test
DRAFT, CANCELLED, RUNNING, FAILED, PASSED Last update date of the workflow test
Identifier of the associated workflow
List of expectations that will be executed for the workflow test
Unique key for the expectation (max 256 characters)
1 - 256Name of the expectation (max 256 characters)
1 - 256Unique identifier for the expectation
256Output of the expectation
JavaScript code that results in a boolean value determining if the expectation passed or failed
10240Status of the expectation
PASSED, FAILED Default input values for the workflow test
Was this page helpful?