Docs »

Automations »

Commands »

queue.push

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:

Key  
available_at@date: The optional future date to process the message
queue_name: The queue name to add messages to
messages: An array of messages to add. These can be strings or objects

output:

Save the queue push result to this placeholder.

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:

Key  
error The error message.