Blocks & Flow EditorCommon
read queue
Read the next item from a Bot Management Console queue
The read queue block reads data from a Bot Management Console queue. Use it to process transaction items pushed to a queue by external systems or upstream tasks.
Configuration
| Field | Description |
|---|---|
| Name | Optional display label on the canvas. |
| Api Key | API key for the Orchestrator queue (required). Obtain from your Orchestrator organization settings. |
| Queue Name | Name of the queue to read from. Must match a queue created in Bot Management Console. |
Outputs
| Port | Label | Description |
|---|---|---|
| Lower | true | Item was read successfully — msg.payload contains the queue item data |
| Upper | false | No item available or read failed — connect retry or exit logic here |
Notes
- Queues must be created and populated in Bot Management Console before this block can read items
- The agent must be connected to Orchestrator with valid credentials
- Use the false output to handle empty queues (e.g. wait and retry, or end the task)
- Queue items are typically processed one at a time per read