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 a Collection
Modify an existing collection.
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"app": {
"id": "<string>",
"name": "<string>",
"verified": true
},
"tags": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>",
"app_id": "<string>",
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}
],
"records_count": 123,
"deleted": true,
"triggers": [
{
"id": "<string>",
"type": "ENCOMPASS",
"name": "My Encompass Trigger",
"config": {
"type": "ENCOMPASS",
"mappings": [
{
"type": "document",
"entity_path": "<string>",
"input_path": [
"<string>"
],
"name": "<string>"
}
],
"pull_on_millestones": [
"Application Received",
"Underwriting Complete",
"Clear to Close"
],
"pull_on_folders": [
"Loan Folder",
"Document Folder",
"Underwriting Folder"
]
},
"enabled": true,
"connection_id": "con_xxx",
"collection_id": "<string>",
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}
],
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"link": "<string>",
"config": {
"id": "<string>",
"mappings": [
{
"source_path": "LOAN_APPLICATION:income",
"destination_paths": [
"MONTHLY_INCOME:amount",
"ANNUAL_INCOME:amount"
]
}
],
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"rules": [
{
"name": "Check Business Name",
"key": "CHECK_BUSINESS_NAME",
"on_success": "PASS",
"on_fail": "WARN",
"workflow_id": "work_xxx",
"workflow_version_id": "workv_xxx",
"workflow_use_latest": true,
"workflow": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"app": {
"id": "<string>",
"name": "<string>",
"verified": true
},
"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>"
}
},
"tags": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>",
"app_id": "<string>",
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}
],
"template_id": "<string>",
"runs_count": 0,
"retention": {
"max_age_in_seconds": 3600,
"preserve_on_failure": true
},
"enabled": true,
"deleted": false,
"created_at": "2023-12-25",
"updated_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
}
}
],
"tests_stats": {
"total_count": 123,
"running_count": 123,
"cancelled_count": 123,
"passing_count": 123,
"failing_count": 123,
"expectations_failing_count": 123,
"expectations_passing_count": 123
}
},
"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>"
}
},
"execution_order": "before-all",
"step_key": "<string>",
"workflow_input_default": {
"business_name": "Example Corp"
},
"disabled": false
}
]
}
}Path Parameters
The ID of the app
The ID of the collection
Body
Specify the changes you want to make to the collection.
How you want to change your collection
What you want to call your new collection (keep it under 64 characters)
1 - 64"My New Collection"
A short blurb about your collection (up to 1024 characters)
1024"This is a description of my new collection"
Tags you want to add to your collection (up to 20)
20["tag_xxx", "tag_yyy"]Response
You'll receive the updated collection details.
Detailed information about a collection including its config (rules, triggers, etc.)
Unique identifier for the collection
Name of the collection
Description of the collection
Tags attached to this collection
Show child attributes
Show child attributes
Unique identifier for the tag
Name of the tag
Color associated with the tag
Identifier for the associated app
Timestamp when the tag was created
Timestamp when the tag was last updated
How many records are in the collection
Has the collection been deleted
Triggers associated with the collection
Show child attributes
Show child attributes
Unique identifier for the trigger
Service that the trigger is connected to
ENCOMPASS, PERSONA "ENCOMPASS"
Name of the trigger
"My Encompass Trigger"
Configuration of the trigger
- Option 1
- Option 2
Show child attributes
Show child attributes
Type of the trigger connection
ENCOMPASS Mappings of the trigger
512Detailed information about a trigger mapping
Milestones to pull from Encompass
5512[
"Application Received",
"Underwriting Complete",
"Clear to Close"
]Folders to pull from Encompass
5512[
"Loan Folder",
"Document Folder",
"Underwriting Folder"
]Whether the trigger is enabled or not
Unique identifier of the connected service
"con_xxx"
Unique identifier of the collection this trigger belongs to
Creation date of the trigger
Last update date of the trigger
Timestamp when the collection was created
Timestamp when the collection was last updated
Link to the collection in the UI
Show child attributes
Show child attributes
Unique identifier for the collection configuration
List of input field mappings of the collection
Timestamp when the configuration was created
Timestamp when the configuration was last updated
List of rules associated with the collection with workflow details
Show child attributes
Show child attributes
Name of the rule
"Check Business Name"
Unique key of the rule within the collection
"CHECK_BUSINESS_NAME"
Action to take if the rule passes
PASS, FAIL, WARN "PASS"
Action to take if the rule fails
PASS, FAIL, WARN "WARN"
Unique identifier of the linked workflow
"work_xxx"
Unique identifier of the specific workflow version to use
"workv_xxx"
Should the rule use the latest version of the workflow?
true
Detailed information about a workflow
Show child attributes
Show child attributes
Unique identifier for the workflow
Name of the workflow
Description of the workflow
Current version of the workflow
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
Tags associated with the workflow
Show child attributes
Show child attributes
Unique identifier for the tag
Name of the tag
Color associated with the tag
Identifier for the associated app
Timestamp when the tag was created
Timestamp when the tag was last updated
Unique identifier for the template
Number of runs of the workflow
0
Data retention policy for the run
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
}Indicates if the workflow is enabled
true
Indicates if the workflow is deleted
false
Creation date of the workflow
Last update date of the workflow
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 >= 100Statistics of the workflow tests
Show child attributes
Show child attributes
Total number of workflow tests
Number of running workflow tests
Number of cancelled workflow tests
Number of passing workflow tests
Number of failing workflow tests
Number of expectations failing in workflow tests
Number of expectations passing in workflow tests
Information about the workflow version
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
When to run this rule compared to others
"before-all"
Step key to run the rule on
Whether the rule is disabled
false
Was this page helpful?
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"app": {
"id": "<string>",
"name": "<string>",
"verified": true
},
"tags": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>",
"app_id": "<string>",
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}
],
"records_count": 123,
"deleted": true,
"triggers": [
{
"id": "<string>",
"type": "ENCOMPASS",
"name": "My Encompass Trigger",
"config": {
"type": "ENCOMPASS",
"mappings": [
{
"type": "document",
"entity_path": "<string>",
"input_path": [
"<string>"
],
"name": "<string>"
}
],
"pull_on_millestones": [
"Application Received",
"Underwriting Complete",
"Clear to Close"
],
"pull_on_folders": [
"Loan Folder",
"Document Folder",
"Underwriting Folder"
]
},
"enabled": true,
"connection_id": "con_xxx",
"collection_id": "<string>",
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}
],
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"link": "<string>",
"config": {
"id": "<string>",
"mappings": [
{
"source_path": "LOAN_APPLICATION:income",
"destination_paths": [
"MONTHLY_INCOME:amount",
"ANNUAL_INCOME:amount"
]
}
],
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"rules": [
{
"name": "Check Business Name",
"key": "CHECK_BUSINESS_NAME",
"on_success": "PASS",
"on_fail": "WARN",
"workflow_id": "work_xxx",
"workflow_version_id": "workv_xxx",
"workflow_use_latest": true,
"workflow": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"app": {
"id": "<string>",
"name": "<string>",
"verified": true
},
"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>"
}
},
"tags": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>",
"app_id": "<string>",
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}
],
"template_id": "<string>",
"runs_count": 0,
"retention": {
"max_age_in_seconds": 3600,
"preserve_on_failure": true
},
"enabled": true,
"deleted": false,
"created_at": "2023-12-25",
"updated_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
}
}
],
"tests_stats": {
"total_count": 123,
"running_count": 123,
"cancelled_count": 123,
"passing_count": 123,
"failing_count": 123,
"expectations_failing_count": 123,
"expectations_passing_count": 123
}
},
"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>"
}
},
"execution_order": "before-all",
"step_key": "<string>",
"workflow_input_default": {
"business_name": "Example Corp"
},
"disabled": false
}
]
}
}