Admin: Queue listener setup

Queue listeners facilitate the monitoring of a ‘listener queue’ for the arrival of data.  Data arrives in the form of JSON packages – placed on the queue e.g. by an external system, or at submission of a web form.  Downstream queue activities can then use this data to execute offers.  Queue listeners might typically be used for the sending of emails e.g. after a customer makes a purchase, or when a web form is submitted in a landing page. 

More details on queue listeners can be found in the RPI Reference Guide.  Please follow these steps to configure RPI to use queue listeners: 

• Configure the listener queue provider in the Queue Listener Providers configuration interface. 

• Ensure the following QueueListener app settings are set for the Execution and Node Manager services:

  • IsEnabled: set to True.

  • QueuePath: set to the path of the queue to be used as listener queue.

• Set the ListenerQueuePath realtime app setting value to the same value as QueuePath.

• In the Queue Listener Providers configuration interface, copy the listener queue’s JSON configuration to the clipboard.

• Paste the same into the Realtime appsettings.json file’s ListenerQueueSettings section.

Any messages received for an inactive trigger can be pushed to a separate queue, defined using the following settings:

RPIExecution__QueueListener__ListenerQueueNonActiveQueuePath

RPIExecution__QueueListener__ListenerQueueNonActiveTTLDays

Any messages received that result in error (e.g. missing trigger key /malformed json)  can be pushed to a separate queue, defined using the following settings:

RPIExecution__QueueListener__ListenerQueueErrorQueuePath

RPIExecution__QueueListener__ListenerQueueErrorTTLDays