The queue.push: command adds new messages to a queue.

start:
  queue.push:
    inputs:
      queue_name: example.queue.name
      messages:
        0:
          id: message0
          priority: high
        1:
          id: message1
          priority: low
    output: results

• Syntax
  • inputs:
    • job_id:
  • output:
  • on_simulate:
  • on_success:
  • on_error:

Syntax

inputs:

job_id:

Messages can be grouped into a queue job so that progress across the whole batch can be monitored as a single unit.

This key associates messages with an existing job. It doesn't create one. The value is stored on each message as given. If you push messages with a job ID that doesn't exist, they're still queued and processed normally, but there's no job record to track them with – and no progress monitor.

Create the queue job record first, then pass its id:

start:
  record.search:
    inputs:
      record_type: queue
      record_query: name:"example.queue.name" limit:1
    output: queue
    on_success:
      record.create:
        inputs:
          record_type: queue_job
          fields:
            name: Review historical tickets
            queue_id@int: {{queue.id}}
        output: job
        on_success:
          queue.push:
            inputs:
              queue_name: example.queue.name
              job_id@int: {{job.id}}
              messages:
                0:
                  id: message0

output:

Save the queue push result to this placeholder.

This parameter is optional. It's only needed when you want to capture the resulting queue message IDs.

on_simulate:

The commands to run during simulation instead of pushing messages to the queue.

If omitted, messages are pushed to the queue during simulation.

on_success:

The commands to run on success.

The output: placeholder contains an array of unique queue message IDs. These can be reused to look up eventual message processing success or failure.

on_error:

The commands to run on failure. If omitted, the automation exits in the error state.

The output: placeholder receives a dictionary with these keys: