C TWO (Preview)
C TWO is an Agentic Management Platform that orchestrates automation workflows, manages human-robot interactions, and processes work items through universal queues. Use this connector to trigger flows from C TWO sessions, manage session lifecycle, create and process queue items, and enable human-in-the-loop interactions with digital workers.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | C TWO Support |
| URL | https://ctwo.com/ |
| customersuccess@ctwo.com |
| Connector Metadata | |
|---|---|
| Publisher | C TWO |
| Website | https://ctwo.com/ |
| Privacy policy | https://ctwo.com/privacy-policy/ |
| Categories | Business Intelligence;AI |
C TWO
C TWO is an Agentic Management Platform that orchestrates automation workflows, manages human‑robot interactions, and processes work items through universal queues. This connector lets Power Automate, Power Apps, Azure Logic Apps, and Copilot Studio trigger and be triggered by C TWO sessions, manage session lifecycle, create and process Universal Queue items, and enable human‑in‑the‑loop interactions with digital workers.
C TWO sits above your automation estate as a single orchestration, governance, and monitoring layer: whatever creates or executes the work, C TWO adds SLA tracking, retries and self‑healing, live session telemetry, and a full audit trail.
Prerequisites
Before creating a connection you will need:
- An active C TWO tenant — either C TWO Cloud (hosted) or an on‑premises C TWO server reachable over HTTPS.
- A Service Account token or Personal Access Token issued by your C TWO administrator (see Obtaining credentials).
- If C TWO is hosted on‑premises, the server must be reachable from Power Platform over HTTPS (firewall allowing Microsoft's Power Automate outbound IP ranges — Azure Service Tags
AzureConnectors.<region>andPowerPlatformPlexfor your Power Platform Geo). - A Power Platform environment with Custom Connector permissions and a license tier that supports custom connectors (Power Automate Premium or equivalent).
Creating a connection
When you create a connection you provide three values, all from your own C TWO environment:
- C TWO Host — your C TWO server hostname only (no scheme, no trailing slash), e.g.
connect24.ctwo.cloud, or an on‑premises host with optional port such asctwo.contoso.com:8443. - C TWO Base URL — the base path of your C TWO API including your division, starting with a slash and with no trailing slash, e.g.
/DEFAULT/CTWO.Server/api. - API Key — your token, entered as
Bearer <your-token>. A Service Account token is recommended; a Personal Access Token also works.
Together, Host and Base URL route the connector to your own C TWO server (https://{Host}{Base URL}/…), so each customer connects to their own environment — C TWO Cloud or on‑premises.
Obtaining credentials
Authentication uses an API key sent as a Bearer token in the Authorization header.
Service Account token (recommended for production)
- Sign in to your C TWO instance.
- Go to Apps and Connections → Microsoft Power Automate → Create service account.
- Copy the generated token immediately — it is shown only once.
Personal Access Token (development/testing)
- Open your user profile in C TWO.
- Go to the API Tokens tab and generate a new token.
- Copy it immediately — it is shown only once and is invalidated if the user account is disabled.
Treat both token types as secrets — store them only in the Power Platform connection credential, never in flow variables or client‑side code.
Supported operations
- Triggers — Start a flow when C TWO dispatches a session, with or without an enforced timeout.
- Session management — Report completion/failure, write typed session logs, adjust the session timeout, and check for a graceful stop request.
- Universal Queue — Create, list, lock, unlock, retry, and defer queue items; update item data and add item‑level logs; add/remove tags; retrieve attachments; create custom item states; list queues.
- Human‑in‑the‑loop — Create, assign, unassign, and complete structured human‑assistance forms, and retrieve/query them.
Internal helper operations populate dynamic dropdowns (task and user pickers) and are not called directly.
Known issues and limitations
- Correct Host and Base URL required. Both are entered at connection time and route the connector to your C TWO server. Incorrect or unreachable values result in connection or request failures.
- API Key format. The API Key field expects the literal string
Bearer <token>— omitting theBearerprefix results in401 Unauthorized. - Supplying JSON item data. Item‑data fields (
Create Queue Item,Set Queue Item Data) are JSON objects. In a flow, supply literal JSON with thejson('…')expression so it is sent as an object rather than a string. - Polling trigger latency. Triggers poll rather than push, so there is a small delay (bounded by the trigger recurrence) between a session being dispatched in C TWO and the flow starting.
- Form field types. Some identifier fields returned by the form operations may be an integer, a string, or null depending on the form's state.
Common errors and remedies
| Error | Likely cause | Remedy |
|---|---|---|
401 Unauthorized |
API Key missing the Bearer prefix, expired, or revoked |
Re‑enter the credential as Bearer <token>; generate a new Service Account token if revoked |
400 Bad request on Create Queue Item |
Missing a required field (reference, queueItemState, itemKey) |
Populate all three required fields |
| Trigger never fires | Wrong task selected, or the C TWO task is not exposed to Power Automate | Confirm the task appears in the Task ID dropdown and is configured as an exposed flow in C TWO |
| Item data stored as an escaped string | JSON supplied as text instead of an object | Use the json('…') expression (flows) or Raw Body (connector test) so it is sent as an object |
FAQ
Can I use this connector from Power Apps, Azure Logic Apps, and Copilot Studio, not just Power Automate? Yes. The triggers are Power Automate–specific, but every action can be called from any of these platforms once a connection is created.
Does this connector manage licensing? No. C TWO orchestrates and governs execution; customers are responsible for their own Microsoft licensing.
Where can I get help? Contact C TWO Customer Success at customersuccess@ctwo.com.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| C TWO Host | string | Your C TWO server hostname only — no scheme, no trailing slash. For example connect24.ctwo.cloud, or an on-premises host with optional port such as ctwo.contoso.com:8443. | True |
| C TWO Base URL | string | The base path of your C TWO API including your division. Start with a slash, no trailing slash. For example /DEFAULT/CTWO.Server/api. | True |
| API Key | securestring | Your C TWO API token, entered as: Bearer <your-token>. A Service Account token is recommended; a Personal Access Token also works. | True |
Actions
| Add Log to Queue Item |
Adds a log message to a queue item for audit trail and traceability. Use this action to record processing steps, warnings, or errors against a specific work item. |
| Add Log to Session |
Writes a log entry to a C TWO session. Use this action to track progress, record decisions, or log diagnostic information during flow execution. Logs are visible in the C TWO platform for auditing and troubleshooting. |
| Add Tags to Queue Item |
Adds one or more tags to a queue item for categorization and filtering. Tags help organize and search for work items across queues. |
| Assign Form |
Assigns a robot interaction form to a specific user, making them responsible for reviewing and completing the human-in-the-loop request. |
| Complete Form |
Marks a robot interaction form as completed, signaling that the human user has provided the requested input and the digital worker can resume processing. |
| Create Form |
Creates a new robot interaction form that allows a digital worker to request human assistance. The form is presented to assigned users in the C TWO platform, enabling human-in-the-loop scenarios where human expertise is needed to handle exceptions or complex decisions. |
| Create Queue Item |
Creates a new work item in a specified universal queue. Use this action to add items for processing by digital workers, including data payloads, tags, and optional file attachments. |
| Create Queue Item State |
Creates a new custom state within a specific queue. Custom states allow you to define workflow stages beyond the default states (Pending, Completed, Referred), tailoring the queue to your business process. |
| Defer Queue Item |
Defers a queue item so it will not be processed until the specified date/time. Use this action when an item cannot be processed now but should be retried later. |
| Get Form By Id |
Retrieves a specific robot interaction form by its unique identifier. Use this action to fetch the details, fields, and current status of a human-in-the-loop form that was created by a digital worker. |
| Get Forms |
Retrieves a list of robot interaction forms with optional filtering. Use this action to query pending human-in-the-loop requests, check their status, or find forms assigned to specific users. |
| Get Queue Item Attachment |
Retrieves a specific file attachment from a queue item as base64-encoded data. Use this action to download files that were attached to work items during creation or processing. |
| Get Queue Items |
Retrieves queue items based on specified filter criteria such as state, tags, dates, and queue names. Use this action to search for and monitor work items across your universal queues. |
| Get Queues |
Retrieves universal queues based on filter criteria. Use this action to list available queues, check their configuration, or look up queue details. This operation also powers dynamic dropdowns in other actions. |
| Lock Queue Item |
Locks a queue item to prevent other workers from processing it concurrently. Use this action before processing a work item to ensure exclusive access. |
| Remove Tags from Queue Item |
Removes one or more tags from a queue item. Use this action to update the categorization of work items during processing. |
| Retry Queue Item |
Retry a specific queue item, setting its data back to its original value and creating a new Attempt. |
| Set Flow Execution State to Completed |
Marks a C TWO session as completed, signaling that the flow has finished its work successfully. Place this action at the end of your flow to report back to C TWO that the automation completed without errors. |
| Set Flow Execution State to Failed |
Marks a C TWO session as failed, signaling that an error occurred during flow execution. Use this action in error-handling scopes to report failures back to C TWO with details about what went wrong. |
| Set Queue Item Data |
Updates the data content of a queue item. Use this action to modify the payload of a work item during processing, for example to store intermediate results. |
| Set Queue Item State |
Changes the state of a queue item (e.g., from Pending to Completed, or to a custom state). Use this action to advance items through your workflow pipeline. |
| Set Session Timeout |
Updates the timeout value for an active C TWO session. Use this action to extend or reduce the allowed execution time for a running session when the original timeout needs adjustment. |
| Should Session Stop |
Checks whether C TWO has requested a graceful (soft) stop for the given session. Use this action inside loops to periodically check if the session should terminate early, allowing the flow to clean up resources before stopping. |
| Unassign Form |
Removes the current user assignment from a robot interaction form, making it available for other users to claim. |
| Unlock Queue Item |
Unlocks a previously locked queue item and returns it to its available state. Use this action when processing is interrupted and the item should be released for other workers. |
Add Log to Queue Item
Adds a log message to a queue item for audit trail and traceability. Use this action to record processing steps, warnings, or errors against a specific work item.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Queue Item ID
|
queueItemId | True | string |
The ID of the queue item to log to. |
|
Log Level
|
level | string |
The severity level of the log entry. |
|
|
Message
|
message | string |
The log message content. |
Add Log to Session
Writes a log entry to a C TWO session. Use this action to track progress, record decisions, or log diagnostic information during flow execution. Logs are visible in the C TWO platform for auditing and troubleshooting.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Session ID
|
sessionId | True | string |
The C TWO session ID where the log entry will be recorded. Defaults to the session ID from the trigger output. |
|
level
|
level | True | string |
The severity level of the log entry. |
|
message
|
message | True | string |
The log message content to record. |
Returns
Add Tags to Queue Item
Adds one or more tags to a queue item for categorization and filtering. Tags help organize and search for work items across queues.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Queue Item ID
|
queueItemId | True | string |
The ID of the queue item to add tags to. |
|
Tags
|
tags | string |
Comma-separated list of tags to add. |
Assign Form
Assigns a robot interaction form to a specific user, making them responsible for reviewing and completing the human-in-the-loop request.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Form ID
|
formId | True | string |
Human in the loop form id to assign. |
|
userId
|
userId | integer |
The ID of the user to assign the form to. |
Returns
Complete Form
Marks a robot interaction form as completed, signaling that the human user has provided the requested input and the digital worker can resume processing.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Form ID
|
formId | True | string |
Human in the loop form id to mark as completed. |
|
completedAt
|
completedAt | date-time |
The timestamp when the form was completed (ISO 8601 format). |
Returns
Create Form
Creates a new robot interaction form that allows a digital worker to request human assistance. The form is presented to assigned users in the C TWO platform, enabling human-in-the-loop scenarios where human expertise is needed to handle exceptions or complex decisions.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
fields
|
fields | string |
JSON-formatted string defining the form fields that the human user needs to fill in. |
|
|
title
|
title | string |
The title displayed to the human user when they open the form. |
|
|
deadline
|
deadline | date-time |
The deadline by which the human must respond to the form (ISO 8601 format). |
|
|
intro
|
intro | string |
Introductory text shown to the human user explaining what action is needed. |
|
|
itemId
|
itemId | integer |
The queue item ID associated with this form, linking the human interaction to a specific work item. |
|
|
workflowTaskId
|
workflowTaskId | integer |
The C TWO task that created this form. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
id |
Create Queue Item
Creates a new work item in a specified universal queue. Use this action to add items for processing by digital workers, including data payloads, tags, and optional file attachments.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Item Key
|
itemKey | True | string |
A unique business key to identify this queue item (e.g., invoice number, case ID). |
|
Queue Item State
|
queueItemState | True | string |
The initial state of the queue item (e.g., Pending). |
|
Queue Reference
|
reference | True | string |
The queue reference where the item will be created. |
|
Deferred Until
|
deferredUntil | date-time |
Defer processing until this date/time (ISO 8601 format). |
|
|
Item Data
|
itemData | object |
The data payload for the queue item in JSON format. |
|
|
Tags
|
tags | string |
Tags for the queue item (comma-separated). |
|
|
fileName
|
fileName | string |
The name of the attachment file. |
|
|
fileData
|
fileData | string |
The base64 encoded file data. |
|
|
Session ID
|
sessionId | string |
The session ID associated with this item. |
|
|
Device
|
device | string |
The device that created this item. |
|
|
User
|
user | string |
The user who created this item. |
|
|
Automation Provider
|
automationProvider | string |
The automation provider for this item. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
id |
|
itemKey
|
itemKey | string |
itemKey |
|
attempts
|
attempts | integer |
attempts |
|
queueId
|
queueId | integer |
queueId |
|
id
|
state.id | integer |
id |
|
name
|
state.name | string |
name |
|
state
|
state.state | string |
state |
|
tags
|
tags | array of string |
tags |
|
created
|
created | string |
created |
|
createdByVendorSessionId
|
createdByVendorSessionId | integer |
createdByVendorSessionId |
|
concluded
|
concluded | string |
concluded |
|
deferred
|
deferred | string |
deferred |
|
test
|
test | boolean |
test |
|
locked
|
locked | boolean |
locked |
Create Queue Item State
Creates a new custom state within a specific queue. Custom states allow you to define workflow stages beyond the default states (Pending, Completed, Referred), tailoring the queue to your business process.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Name
|
name | string |
The name of the new state. |
|
|
Response Time Calculation
|
responseTimeCalculationBasis | True | string |
Determines how response time SLAs are calculated for items entering this state. |
|
State Type
|
state | True | string |
The type of state (Pending, Completed, or Referred). |
|
Queue ID
|
queueId | True | integer |
The ID of the queue where this state will be created. |
|
Description
|
description | string |
A description of what this state represents in your workflow. |
|
|
Time Saved Per Item
|
timeSavedPerItem | integer |
Time saved per item in this state (seconds), used for ROI reporting. |
|
|
Value Generated Per Item
|
valueGeneratedPerItem | integer |
Value generated per item in this state, used for ROI reporting. |
|
|
Include In Reports
|
includeInReports | boolean |
Whether to include this state in analytics and reports. |
Defer Queue Item
Defers a queue item so it will not be processed until the specified date/time. Use this action when an item cannot be processed now but should be retried later.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Queue Item ID
|
queueItemId | True | string |
The ID of the queue item to defer. |
|
Deferred Until
|
deferredUntil | date-time |
The date/time to defer until (ISO 8601 format). |
Returns
- response
- string
Get Form By Id
Retrieves a specific robot interaction form by its unique identifier. Use this action to fetch the details, fields, and current status of a human-in-the-loop form that was created by a digital worker.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Form ID
|
formId | True | string |
Human in the loop form id to get details. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
id |
|
divisionId
|
divisionId |
divisionId |
|
|
sessionId
|
sessionId |
sessionId |
|
|
queueItemId
|
queueItemId |
queueItemId |
|
|
claimedByUserId
|
claimedByUserId |
claimedByUserId |
|
|
claimedOn
|
claimedOn | string |
claimedOn |
|
createdByWorkflowTaskId
|
createdByWorkflowTaskId |
createdByWorkflowTaskId |
|
|
createdByUserId
|
createdByUserId |
createdByUserId |
|
|
createdOn
|
createdOn | string |
createdOn |
|
deadline
|
deadline | string |
deadline |
|
completed
|
completed | string |
completed |
|
title
|
title | string |
title |
|
intro
|
intro | string |
intro |
|
fields
|
fields | string |
fields |
Get Forms
Retrieves a list of robot interaction forms with optional filtering. Use this action to query pending human-in-the-loop requests, check their status, or find forms assigned to specific users.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Skip
|
skip | integer |
Number of records to skip for pagination. |
|
|
Take
|
take | integer |
Number of records to return. |
|
|
Deadline Before
|
deadlineBefore | date-time |
Filter forms with a deadline before this date/time (ISO 8601). |
|
|
Deadline After
|
deadlineAfter | date-time |
Filter forms with a deadline after this date/time (ISO 8601). |
|
|
Include Completed
|
includeCompleted | boolean |
Whether to include completed forms in the results. |
|
|
Claimed By User ID
|
claimedByUserId | integer |
Filter forms claimed by a specific user ID. |
|
|
Created By Workflow Task ID
|
createdByWorkflowTaskId | integer |
Filter forms created by a specific workflow task ID. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | integer |
id |
|
divisionId
|
divisionId |
divisionId |
|
|
sessionId
|
sessionId |
sessionId |
|
|
queueItemId
|
queueItemId |
queueItemId |
|
|
claimedByUserId
|
claimedByUserId |
claimedByUserId |
|
|
claimedOn
|
claimedOn | string |
claimedOn |
|
createdByWorkflowTaskId
|
createdByWorkflowTaskId |
createdByWorkflowTaskId |
|
|
createdByUserId
|
createdByUserId |
createdByUserId |
|
|
createdOn
|
createdOn | string |
createdOn |
|
deadline
|
deadline | string |
deadline |
|
completed
|
completed | string |
completed |
|
undeferred
|
undeferred | boolean |
undeferred |
Get Queue Item Attachment
Retrieves a specific file attachment from a queue item as base64-encoded data. Use this action to download files that were attached to work items during creation or processing.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Queue Item ID
|
queueItemId | True | string |
The ID of the queue item containing the attachment. |
|
Attachment ID
|
attachmentId | True | string |
The ID of the attachment to retrieve. |
|
Filename
|
filename | string |
The filename of the attachment. |
Returns
- response
- string
Get Queue Items
Retrieves queue items based on specified filter criteria such as state, tags, dates, and queue names. Use this action to search for and monitor work items across your universal queues.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Item Key
|
itemKey | string |
Filter by item key. |
|
|
Attempts
|
attempts | integer |
Filter by number of attempts. |
|
|
Deferred Before
|
deferredBefore | date-time |
Filter items deferred before this date. |
|
|
Deferred After
|
deferredAfter | date-time |
Filter items deferred after this date. |
|
|
Created Before
|
createdBefore | date-time |
Filter items created before this date. |
|
|
Created After
|
createdAfter | date-time |
Filter items created after this date. |
|
|
Concluded Before
|
concludedBefore | date-time |
Filter items concluded before this date. |
|
|
Concluded After
|
concludedAfter | date-time |
Filter items concluded after this date. |
|
|
State Entered Before
|
stateEnteredTimeBefore | date-time |
Filter items that entered state before this time. |
|
|
State Entered After
|
stateEnteredTimeAfter | date-time |
Filter items that entered state after this time. |
|
|
States
|
states | string |
Filter by queue item state. |
|
|
Queue Item State IDs
|
queueItemStateIds | integer |
Filter by queue item state IDs. |
|
|
Queue Item State Names
|
queueItemStateNames | string |
Filter by queue item state names. |
|
|
Tags
|
tags | string |
Filter by tags (comma-separated). |
|
|
Queue IDs
|
queueIds | integer |
Filter by queue IDs. |
|
|
Queue Names
|
queueNames | True | string |
Filter by queue names (required). |
|
References
|
references | string |
Filter by queue references. |
|
|
Include Item Data
|
includeItemData | boolean |
Whether to include item data in response. |
|
|
Skip
|
skip | integer |
Number of records to skip for pagination. |
|
|
Take
|
take | integer |
Number of records to return. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | integer |
The unique identifier of the queue item. |
|
itemKey
|
itemKey | string |
The unique key of the queue item. |
|
attempts
|
attempts | integer |
The number of processing attempts. |
|
queueId
|
queueId | integer |
The identifier of the parent queue. |
|
id
|
state.id | integer |
The state identifier. |
|
name
|
state.name | string |
The name of the state. |
|
state
|
state.state | string |
The state value. |
|
tags
|
tags | array of string |
The tags associated with the queue item. |
|
created
|
created | string |
The creation timestamp. |
|
createdByVendorSessionId
|
createdByVendorSessionId | integer |
The session ID that created this item. |
|
concluded
|
concluded | string |
The conclusion timestamp. |
|
deferred
|
deferred | string |
The deferred timestamp. |
|
test
|
test | boolean |
Whether this is a test item. |
|
locked
|
locked | boolean |
Whether the item is locked. |
Get Queues
Retrieves universal queues based on filter criteria. Use this action to list available queues, check their configuration, or look up queue details. This operation also powers dynamic dropdowns in other actions.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Queue ID
|
id | string |
Filter by queue ID. |
|
|
Queue Reference
|
reference | string |
Filter by queue reference. |
|
|
Queue Name
|
name | string |
Filter by queue name. |
|
|
State Name
|
stateName | string |
Filter by state name. |
|
|
Deleted
|
deleted | boolean |
Filter by deleted status. |
|
|
Skip
|
skip | integer |
Number of records to skip for pagination. |
|
|
Take
|
take | integer |
Number of records to return. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | integer |
The unique identifier of the queue. |
|
deleted
|
deleted | boolean |
Whether the queue is deleted. |
|
name
|
name | string |
The name of the queue. |
|
description
|
description | string |
The description of the queue. |
|
visible
|
visible | boolean |
Whether the queue is visible. |
|
includeInReports
|
includeInReports | boolean |
Whether to include in reports. |
|
created
|
created | string |
The creation timestamp. |
|
updated
|
updated | string |
The last update timestamp. |
|
deletedTime
|
deletedTime | string |
The deletion timestamp. |
|
divisionId
|
divisionId | integer |
The division identifier. |
|
type
|
type | integer |
The queue type. |
|
reference
|
reference | string |
The queue reference. |
|
states
|
states | array of object |
The states available in this queue. |
|
id
|
states.id | integer |
The state identifier. |
|
name
|
states.name | string |
The state name. |
|
description
|
states.description | string |
The state description. |
|
tagfilter
|
states.tagfilter | string |
The tag filter for this state. |
|
state
|
states.state | integer |
The state type. |
|
timeSavedPerItem
|
states.timeSavedPerItem | integer |
Time saved per item. |
|
includeInReports
|
states.includeInReports | boolean |
Whether to include in reports. |
|
responseTimeCalculationBasis
|
states.responseTimeCalculationBasis | integer |
Response time calculation basis. |
Lock Queue Item
Locks a queue item to prevent other workers from processing it concurrently. Use this action before processing a work item to ensure exclusive access.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Queue Item ID
|
queueItemId | string |
The ID of the queue item to lock. If omitted, the next available item matching the filter will be locked. |
|
|
Queue Name
|
reference | string |
The queue reference to lock an item from. |
|
|
State ID
|
stateId | string |
The state ID to filter items. |
|
|
State Name
|
stateName | string |
The state name to filter items by. |
|
|
Session ID
|
sessionId | string |
The session ID for this lock. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
The unique identifier of the locked item. |
|
itemKey
|
itemKey | string |
The unique key of the locked item. |
|
attempts
|
attempts | integer |
The number of processing attempts. |
|
queueId
|
queueId | integer |
The identifier of the parent queue. |
|
id
|
state.id | integer |
The state identifier. |
|
name
|
state.name | string |
The name of the state. |
|
state
|
state.state | string |
The state value. |
|
tags
|
tags | array of string |
The tags associated with the queue item. |
|
created
|
created | string |
The creation timestamp. |
|
createdByVendorSessionId
|
createdByVendorSessionId | integer |
The session ID that created this item. |
|
concluded
|
concluded | string |
The conclusion timestamp. |
|
deferred
|
deferred | string |
The deferred timestamp. |
|
test
|
test | boolean |
Whether this is a test item. |
|
locked
|
locked | boolean |
Whether the item is locked. |
Remove Tags from Queue Item
Removes one or more tags from a queue item. Use this action to update the categorization of work items during processing.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Queue Item ID
|
queueItemId | True | string |
The ID of the queue item to remove tags from. |
|
Tags
|
tags | string |
Comma-separated list of tags to remove. |
Retry Queue Item
Retry a specific queue item, setting its data back to its original value and creating a new Attempt.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Queue Item ID
|
queueItemId | True | integer |
Specific queue item id to retry. |
|
State ID
|
stateId | integer |
Specific pending queue item state id to be set; takes priority over state parameter. |
|
|
State
|
state | string |
Specific pending queue item state name to be set. |
|
|
Workflow Task ID
|
workflowTaskId | integer |
WorkflowTask identifier. |
|
|
App ID
|
appId | integer |
App identifier. |
Set Flow Execution State to Completed
Marks a C TWO session as completed, signaling that the flow has finished its work successfully. Place this action at the end of your flow to report back to C TWO that the automation completed without errors.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Session ID
|
sessionId | True | string |
The C TWO session ID to mark as successfully completed. Defaults to the session ID from the trigger output. |
Returns
- response
- object
Set Flow Execution State to Failed
Marks a C TWO session as failed, signaling that an error occurred during flow execution. Use this action in error-handling scopes to report failures back to C TWO with details about what went wrong.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Session ID
|
sessionId | True | string |
The C TWO session ID to mark as failed. Defaults to the session ID from the trigger output. |
|
details
|
details | True | string |
A description of the error or exception that caused the session to fail. |
Returns
Set Queue Item Data
Updates the data content of a queue item. Use this action to modify the payload of a work item during processing, for example to store intermediate results.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Queue Item ID
|
queueItemId | True | string |
The ID of the queue item to update. |
|
Data
|
data | object |
The new data payload for the queue item, as a JSON object. |
|
|
Created
|
created | date-time |
The creation timestamp for this data. |
Set Queue Item State
Changes the state of a queue item (e.g., from Pending to Completed, or to a custom state). Use this action to advance items through your workflow pipeline.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Queue Item ID
|
queueItemId | True | string |
The ID of the queue item to update. |
|
State
|
state | string |
The new state for the queue item. |
Set Session Timeout
Updates the timeout value for an active C TWO session. Use this action to extend or reduce the allowed execution time for a running session when the original timeout needs adjustment.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Session ID
|
sessionId | True | string |
The C TWO session ID to update the timeout for. Defaults to the session ID from the trigger output. |
|
Timeout
|
timeout | True | integer |
The new timeout value in seconds to apply to the session. |
Returns
- response
- string
Should Session Stop
Checks whether C TWO has requested a graceful (soft) stop for the given session. Use this action inside loops to periodically check if the session should terminate early, allowing the flow to clean up resources before stopping.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Session ID
|
sessionId | True | string |
The C TWO session ID to check for a stop request. Defaults to the session ID from the trigger output. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
isStopRequested
|
isStopRequested | boolean |
isStopRequested |
Unassign Form
Removes the current user assignment from a robot interaction form, making it available for other users to claim.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Form ID
|
formId | True | string |
Human in the loop form id to unassign. |
Returns
Unlock Queue Item
Unlocks a previously locked queue item and returns it to its available state. Use this action when processing is interrupted and the item should be released for other workers.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Queue Item ID
|
queueItemId | True | string |
The ID of the queue item to unlock. |
Triggers
| Start Flow from Session Request with Timeout |
Polls for new C TWO sessions and triggers the flow with a timeout constraint. Use this trigger when the automation must complete within a specific time window. If the session exceeds the timeout, C TWO will handle it according to its timeout policy. |
| Start Flow from Session Request without Timeout |
Polls for new C TWO sessions and triggers the flow when a session is created for the selected task. Use this trigger when the automation does not require a timeout constraint. The flow receives session details including input values passed from C TWO. |
Start Flow from Session Request with Timeout
Polls for new C TWO sessions and triggers the flow with a timeout constraint. Use this trigger when the automation must complete within a specific time window. If the session exceeds the timeout, C TWO will handle it according to its timeout policy.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Task ID
|
taskId | True | integer |
Select the C TWO task that will trigger this flow. When a session is created for this task, the flow starts with the specified timeout enforced. |
|
Seconds timeout
|
timeout | True | integer |
Maximum time in seconds that the session is allowed to run before C TWO marks it as timed out. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
sessions
|
sessions | array of object |
Set of sessions triggered by C TWO with timeout |
|
sessionId
|
sessions.sessionId | integer |
sessionId |
|
workflowTaskId
|
sessions.workflowTaskId | integer |
workflowTaskId |
|
workflowName
|
sessions.workflowName | string |
workflowName |
|
taskName
|
sessions.taskName | string |
taskName |
|
created
|
sessions.created | string |
created |
|
processInputValues
|
sessions.processInputValues | object |
processInputValues |
Start Flow from Session Request without Timeout
Polls for new C TWO sessions and triggers the flow when a session is created for the selected task. Use this trigger when the automation does not require a timeout constraint. The flow receives session details including input values passed from C TWO.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Task ID
|
taskId | True | integer |
Select the C TWO task that will trigger this flow. When a new session is created for this task in C TWO, the flow will start automatically without enforcing a timeout. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
sessions
|
sessions | array of object |
Set of sessions triggered by C TWO without timeout |
|
sessionId
|
sessions.sessionId | integer |
sessionId |
|
workflowTaskId
|
sessions.workflowTaskId | integer |
workflowTaskId |
|
workflowName
|
sessions.workflowName | string |
workflowName |
|
taskName
|
sessions.taskName | string |
taskName |
|
created
|
sessions.created | string |
created |
|
processInputValues
|
sessions.processInputValues | object |
processInputValues |
Definitions
string
This is the basic data type 'string'.
object
This is the type 'object'.