Skip to main content
Server path: /queue-management | Type: Embedded | PCID required: No

Tools

ToolDescription
queue-management_create_queueCreate a new queue for managing concurrent execution of automation runs. Configure concurrency limits, retry policies, and priority.
queue-management_list_queuesList all queues in the current organization. Returns queue details including status, concurrency limits, and priority.
queue-management_get_queueGet details for a specific queue by ID, including its configuration, status, and access control.
queue-management_update_queueUpdate queue configuration (name, description, concurrency limit, max retries, priority). Requires the current version number for optimistic locking.
queue-management_delete_queueDelete a queue and all its items. This action is destructive and cannot be undone.
queue-management_start_queueStart processing a paused queue. The queue will begin executing pending runs up to its concurrency limit.
queue-management_pause_queuePause a running queue. In-progress runs will complete, but no new runs will start.
queue-management_get_queue_statsGet statistics for a queue including pending and running item counts. Optionally filter by date range.
queue-management_get_queue_runsList runs for a specific queue. Returns run details including status, timestamps, and results.
queue-management_create_batchCreate a new batch in a queue from a CSV file. Each row becomes a run, executed via the specified trigger. Optionally configure a completion action (trigger or webhook) when the batch finishes.
queue-management_get_batch_statusGet the status of a batch including run counts (requested, complete, failed, timed out) and overall status (pending, running, complete, canceled).

queue-management_create_queue

Create a new queue for managing concurrent execution of automation runs. Configure concurrency limits, retry policies, and priority. Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesName for the queue
descriptionstringNoDescription of the queue purpose
concurrencyLimitnumberYesMaximum number of concurrent runs (must be >= 1)
maxRetriesnumberNo0Maximum retry attempts for failed runs (0-3)
prioritynumberNo5Queue priority (1=highest, 10=lowest, default=5)

queue-management_list_queues

List all queues in the current organization. Returns queue details including status, concurrency limits, and priority. Parameters: None

queue-management_get_queue

Get details for a specific queue by ID, including its configuration, status, and access control. Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesID of the queue to retrieve

queue-management_update_queue

Update queue configuration (name, description, concurrency limit, max retries, priority). Requires the current version number for optimistic locking. Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesID of the queue to update
namestringNoUpdated queue name
descriptionstringNoUpdated queue description
concurrencyLimitnumberNoUpdated maximum concurrent runs
maxRetriesnumberNoUpdated maximum retry attempts (0-3)
prioritynumberNoUpdated priority (1=highest, 10=lowest)
versionnumberYesCurrent version number for optimistic locking (get from queue-management_get_queue)

queue-management_delete_queue

Delete a queue and all its items. This action is destructive and cannot be undone. Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesID of the queue to delete

queue-management_start_queue

Start processing a paused queue. The queue will begin executing pending runs up to its concurrency limit. Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesID of the queue to start

queue-management_pause_queue

Pause a running queue. In-progress runs will complete, but no new runs will start. Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesID of the queue to pause

queue-management_get_queue_stats

Get statistics for a queue including pending and running item counts. Optionally filter by date range. Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesID of the queue
startDatestringNoFilter stats from this date (ISO 8601 format, e.g. 2024-01-01T00:00:00Z)
endDatestringNoFilter stats until this date (ISO 8601 format)

queue-management_get_queue_runs

List runs for a specific queue. Returns run details including status, timestamps, and results. Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesID of the queue
limitnumberNo50Maximum number of runs to return (default: 50)
statusstringNoFilter runs by status (e.g. RUNNING, COMPLETE, FAILED, ERROR)

queue-management_create_batch

Create a new batch in a queue from a CSV file. Each row becomes a run, executed via the specified trigger. Optionally configure a completion action (trigger or webhook) when the batch finishes. Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesID of the queue to add items to
triggerIdstringYesID of the trigger to execute for each queue item
csvUrlstringNoURL to a CSV file (provide either csvUrl or csvData)
csvDatastringNoInline CSV data as a string (provide either csvUrl or csvData)
batchSizenumberNoNumber of rows per batch (0 or 1 = individual rows, >1 = batch mode)
onDoneTriggerIdstringNoTrigger ID to execute when the batch completes
onDoneWebhookUrlstringNoWebhook URL to call when the batch completes

queue-management_get_batch_status

Get the status of a batch including run counts (requested, complete, failed, timed out) and overall status (pending, running, complete, canceled). Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesID of the queue
batchIdstringYesID of the batch to check