Getting Started
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
- GETGet a Workflow Run
- POSTReplay a Workflow Run
- POSTCancel a Workflow Run
- PATCHUpdate Run Data Retention Configuration
- GETGet Workflow Versions
- GETGet a Workflow Version
Tests
Variables
Files
Update Test
Update a specific workflow test by its ID.
{
"id": "<string>",
"name": "<string>",
"status": "PASSED",
"step_key": "<string>",
"expectations_passing_count": 123,
"expectations_failing_count": 123,
"workflow_id": "<string>",
"run": {
"id": "<string>",
"input": {},
"output": {},
"status": "RUNNING",
"origin": "WORKFLOW",
"started_at": "2023-12-25",
"ended_at": "2023-12-25",
"app_id": "<string>",
"workflow_app_id": "<string>",
"workflow_id": "<string>",
"workflow_version_draft": {
"key": "<string>",
"input": {},
"input_default": {},
"input_options": {
"display": {
"field": "inline",
"container": "grid",
"hidden": true
}
},
"steps": [
{
"type": "note",
"key": "<string>",
"note": "<string>",
"display": "expanded",
"conditional": "<string>",
"loop": "<string>",
"throw_on_error": true,
"input_connected": true,
"destinations": [
"<string>"
],
"position": [
123
],
"size": [
101
],
"auto": {
"provider": "<string>",
"model": "<string>",
"temperature": 1
}
}
]
},
"workflow_version": {
"id": "<string>",
"app_id": "<string>",
"workflow_id": "<string>",
"description": "<string>",
"version": 123,
"notes": "<string>",
"created_at": "2023-12-25",
"key": "<string>",
"input": {},
"input_default": {},
"input_options": {
"display": {
"field": "inline",
"container": "grid",
"hidden": true
}
},
"steps": [
{
"type": "note",
"key": "<string>",
"note": "<string>",
"display": "expanded",
"conditional": "<string>",
"loop": "<string>",
"throw_on_error": true,
"input_connected": true,
"destinations": [
"<string>"
],
"position": [
123
],
"size": [
101
],
"auto": {
"provider": "<string>",
"model": "<string>",
"temperature": 1
}
}
],
"rollback_version": 123,
"created_by": {
"id": "<string>",
"name": "<string>"
}
},
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"result": "<unknown>",
"error": "<string>",
"collection_id": "<string>",
"record_id": "<string>",
"version": 123,
"usage": {
"total": 123,
"steps": {},
"calls": [
{
"id": "<string>",
"total": 123,
"calls": [
"<unknown>"
]
}
]
},
"retention": {
"max_age_in_seconds": 3600,
"preserve_on_failure": true
},
"retention_due_at": "2023-12-25"
},
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"input": {},
"input_default": {},
"input_context": {},
"expectations": [
{
"key": "<string>",
"name": "<string>",
"expectation_id": "<string>",
"script": "<string>",
"output": "<unknown>",
"logs": [
"<unknown>"
],
"status": "PASSED"
}
]
}Path Parameters
The ID of the app
The ID of the workflow
The ID of the test
Query Parameters
all Body
Data to update an existing workflow test
Name of the workflow test to be created (max 256 characters)
1 - 256Updated list of expectations for the workflow test
30Show child attributes
Show child attributes
Unique key for the expectation (max 256 characters)
1 - 256Name of the expectation (max 256 characters)
1 - 256Unique identifier for the expectation
256JavaScript code that results in a boolean value determining if the expectation passed or failed
10240Output of the expectation
Status of the expectation
PASSED, FAILED "PASSED"
Updated starting step key for the workflow test
Response
Detailed information about a workflow test
Unique identifier for the workflow test
Name of the workflow test
Status of the workflow test
DRAFT, CANCELLED, RUNNING, FAILED, PASSED "PASSED"
Starting step key for the workflow test
Number of passing expectations
Number of failing expectations
Identifier of the associated workflow
Run details of the workflow test
Show child attributes
Show child attributes
Unique identifier for the run
Output of the run
Show child attributes
Show child attributes
Detailed information about the step run
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Show child attributes
Show child attributes
Status of the step run, must be RUNNING
RUNNING Key of the step run
"STEP_1"
Timestamp of when the step run started
Step type
note, branch, code, model, http_request, browser, workflow, service, input Output of the step run
Show child attributes
Show child attributes
ID of the workflow run that ran this step
ID of the app that this step belongs to
ID of the workflow
ID of the app that the workflow belongs to
Status of the step run
PENDING, RUNNING, CANCELLED, COMPLETED, SKIPPED, FAILED "COMPLETED"
Origin of the step run
WORKFLOW, TRIGGER, RECORD, TEST, ENDPOINT, WEBHOOK "RECORD"
Error message if the step run failed
Date of the workflow step run
Credits usage of the step run
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Result of the workflow step run
Output of the workflow step run
Request information for the workflow step run when executed from API or Webhook
Show child attributes
Show child attributes
HTTP method of the request
URL of the request
IP address of the request
Show child attributes
Show child attributes
Status of the call
PENDING, RUNNING, CANCELLED, COMPLETED, SKIPPED, FAILED Key of the step run
"STEP_1"
Timestamp of when the step run started
Unique identifier for the call
Step type
note, branch, code, model, http_request, browser, workflow, service, input Output of the step run
Show child attributes
Show child attributes
ID of the workflow run that ran this step
ID of the app that this step belongs to
ID of the workflow
ID of the app that the workflow belongs to
Status of the step run
PENDING, RUNNING, CANCELLED, COMPLETED, SKIPPED, FAILED "COMPLETED"
Origin of the step run
WORKFLOW, TRIGGER, RECORD, TEST, ENDPOINT, WEBHOOK "RECORD"
Error message if the step run failed
Date of the workflow step run
Credits usage of the step run
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Result of the workflow step run
Output of the workflow step run
Request information for the workflow step run when executed from API or Webhook
Show child attributes
Show child attributes
HTTP method of the request
URL of the request
IP address of the request
Timestamp of when the step run ended
Error message if the step run failed
Status of the run
PENDING, RUNNING, CANCELLED, COMPLETED, SKIPPED, FAILED "RUNNING"
Origin of the run
WORKFLOW, TRIGGER, RECORD, TEST, ENDPOINT, WEBHOOK "WORKFLOW"
Timestamp of when the run started
Timestamp of when the run ended
ID of the associated app where the run was triggered from
ID of the associated app where the workflow belongs to
ID of the associated workflow
Draft version of the workflow
Show child attributes
Show child attributes
Unique key for the workflow version
Input definition of the workflow
Show child attributes
Show child attributes
The file type allows users to upload files
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
Show child attributes
Show child attributes
The type of the input field
file The name of the input field
1024The description of the input field
10240Indicates whether the input field is optional
Indicates whether the input field can contain multiple values
The placeholder of the input field
512Display options for the file field
Show child attributes
Show child attributes
Controls how the label and input field are arranged (inline or stacked)
inline, stacked Controls how the field container behaves in terms of width and positioning
grid, full, center Indicates whether the input field is hidden from the UI
The render type of the file field
button, dropzone The order of the input field relative to other fields in the form
x >= 0Whether to make the field a configuration field (only visible in the configuration tab)
The link to the documentation for the input field
Additional metadata for the input field
Allowed mime types for the file field (e.g. image/*, application/pdf)
Flag to extract contents from the file
Flag to extract images from the file
Whether the file is private or public, private files URLs are signed with a token and can be accessed temporarily
PUBLIC, PRIVATE "PRIVATE"
Input options of the workflow
Show child attributes
Show child attributes
Display options for the input fields
Show child attributes
Show child attributes
Controls how the label and input field are arranged (inline or stacked)
inline, stacked Controls how the field container behaves in terms of width and positioning
grid, full, center Indicates whether the input field is hidden from the UI
Steps of the workflow at the time this version was deployed
A step that displays as a note on the canvas
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
Show child attributes
Show child attributes
The type of the step
note A unique key for the step
1 - 128The note content (markdown supported)
Display mode of the step
expanded, collapsed, minimal A condition to determine if the step should run
A loop condition for the step to repeat running until the condition is met
Whether to throw an error if the step fails
Whether the step is connected to the input
The step keys that this step connects to
A unique key for the step
1 - 128The position of the step on the canvas
2 elementsThe size of the step on the canvas
2 elementsx >= 100Details of the workflow version used for the run
Show child attributes
Show child attributes
Unique identifier for the workflow version
App id where the workflow version belongs to
Workflow id where the version belongs to
Description of the workflow at the time this version was deployed
Version number
Release notes
Date when the version was deployed
Unique key for the workflow version
Input definition of the workflow
Show child attributes
Show child attributes
The file type allows users to upload files
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
Show child attributes
Show child attributes
The type of the input field
file The name of the input field
1024The description of the input field
10240Indicates whether the input field is optional
Indicates whether the input field can contain multiple values
The placeholder of the input field
512Display options for the file field
Show child attributes
Show child attributes
Controls how the label and input field are arranged (inline or stacked)
inline, stacked Controls how the field container behaves in terms of width and positioning
grid, full, center Indicates whether the input field is hidden from the UI
The render type of the file field
button, dropzone The order of the input field relative to other fields in the form
x >= 0Whether to make the field a configuration field (only visible in the configuration tab)
The link to the documentation for the input field
Additional metadata for the input field
Allowed mime types for the file field (e.g. image/*, application/pdf)
Flag to extract contents from the file
Flag to extract images from the file
Whether the file is private or public, private files URLs are signed with a token and can be accessed temporarily
PUBLIC, PRIVATE "PRIVATE"
Input options of the workflow
Show child attributes
Show child attributes
Display options for the input fields
Show child attributes
Show child attributes
Controls how the label and input field are arranged (inline or stacked)
inline, stacked Controls how the field container behaves in terms of width and positioning
grid, full, center Indicates whether the input field is hidden from the UI
Steps of the workflow at the time this version was deployed
A step that displays as a note on the canvas
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
Show child attributes
Show child attributes
The type of the step
note A unique key for the step
1 - 128The note content (markdown supported)
Display mode of the step
expanded, collapsed, minimal A condition to determine if the step should run
A loop condition for the step to repeat running until the condition is met
Whether to throw an error if the step fails
Whether the step is connected to the input
The step keys that this step connects to
A unique key for the step
1 - 128The position of the step on the canvas
2 elementsThe size of the step on the canvas
2 elementsx >= 100Version number from which this version was rolled back
Timestamp of when the run was created
Timestamp of when the run was last updated
Result of the run
Error message if the run failed
ID of the associated collection
ID of the associated record
Version number of the workflow
Credits usage of the run
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Configuration for how long run data is preserved in the system
Show child attributes
Show child attributes
Maximum time in seconds to retain run data after completion, -1 means no limit (keep indefinitely)
-1 <= x <= 157680000Whether to preserve run data beyond the standard retention period if it fails
true
{
"max_age_in_seconds": 3600,
"preserve_on_failure": true
}Timestamp of when the run data retention policy will be applied
Creation date of the workflow test
Last update date of the workflow test
List of expectations that will be executed for the workflow test
Show child attributes
Show child attributes
Unique key for the expectation (max 256 characters)
1 - 256Name of the expectation (max 256 characters)
1 - 256Unique identifier for the expectation
256JavaScript code that results in a boolean value determining if the expectation passed or failed
10240Output of the expectation
Status of the expectation
PASSED, FAILED "PASSED"
Was this page helpful?
{
"id": "<string>",
"name": "<string>",
"status": "PASSED",
"step_key": "<string>",
"expectations_passing_count": 123,
"expectations_failing_count": 123,
"workflow_id": "<string>",
"run": {
"id": "<string>",
"input": {},
"output": {},
"status": "RUNNING",
"origin": "WORKFLOW",
"started_at": "2023-12-25",
"ended_at": "2023-12-25",
"app_id": "<string>",
"workflow_app_id": "<string>",
"workflow_id": "<string>",
"workflow_version_draft": {
"key": "<string>",
"input": {},
"input_default": {},
"input_options": {
"display": {
"field": "inline",
"container": "grid",
"hidden": true
}
},
"steps": [
{
"type": "note",
"key": "<string>",
"note": "<string>",
"display": "expanded",
"conditional": "<string>",
"loop": "<string>",
"throw_on_error": true,
"input_connected": true,
"destinations": [
"<string>"
],
"position": [
123
],
"size": [
101
],
"auto": {
"provider": "<string>",
"model": "<string>",
"temperature": 1
}
}
]
},
"workflow_version": {
"id": "<string>",
"app_id": "<string>",
"workflow_id": "<string>",
"description": "<string>",
"version": 123,
"notes": "<string>",
"created_at": "2023-12-25",
"key": "<string>",
"input": {},
"input_default": {},
"input_options": {
"display": {
"field": "inline",
"container": "grid",
"hidden": true
}
},
"steps": [
{
"type": "note",
"key": "<string>",
"note": "<string>",
"display": "expanded",
"conditional": "<string>",
"loop": "<string>",
"throw_on_error": true,
"input_connected": true,
"destinations": [
"<string>"
],
"position": [
123
],
"size": [
101
],
"auto": {
"provider": "<string>",
"model": "<string>",
"temperature": 1
}
}
],
"rollback_version": 123,
"created_by": {
"id": "<string>",
"name": "<string>"
}
},
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"result": "<unknown>",
"error": "<string>",
"collection_id": "<string>",
"record_id": "<string>",
"version": 123,
"usage": {
"total": 123,
"steps": {},
"calls": [
{
"id": "<string>",
"total": 123,
"calls": [
"<unknown>"
]
}
]
},
"retention": {
"max_age_in_seconds": 3600,
"preserve_on_failure": true
},
"retention_due_at": "2023-12-25"
},
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"input": {},
"input_default": {},
"input_context": {},
"expectations": [
{
"key": "<string>",
"name": "<string>",
"expectation_id": "<string>",
"script": "<string>",
"output": "<unknown>",
"logs": [
"<unknown>"
],
"status": "PASSED"
}
]
}