Listeners can be added and enabled from the Flint Console. Also, we can view the list of enabled as well as disabled Listeners along with their versions.


With the help of this document, you will be able to add a Listener on the Grid.

How to Add a Listener to the Grid?

Let us see how we can add and enable a Listener in simple steps as below:

  1. Log on to Flint UI Console
  2. Visit the Listeners link on left navigation bar
  3. Click on Add Listener
  4. In the form displayed, fill up necessary form fields ( as shown below )
  5. Click on Add button

Configuration parameters

NameName of the Listener to add.true
TypeA list of all the listeners available with Flint is displayed here. Choose the Listener type, from the listing. The type uses the following naming convention: flint-[listener type]-listener. Example: Type for a IMAP listener is: flint-imap-listener.true
VersionVersion Of the Listener to add.true
TriggerFlintbit reference path or Flintbit name ( flint's convention ), which will trigger Flint to take relevant action based on the type of Listener. Example : example:email_trigger.rbtrue
DescriptionSummarization of the Listenerfalse
Nr of instancesThe number of instances with which the Listener will be enabled. Every instance is single threaded which will scale your application across all available worknodes you might want to deploy on. If omitted a Listener will be enabled with single instance.false
HA OptionsFlint allows you to enable the Listener with high availability ( HA ) support.
  • Auto-HA: The behaviour of Auto-HA in Listener is different from that in connector. If a worknode on which it is running fails, it will be re-started automatically on another worknode of the grid
  • Worknodes: Listener will be enabled only on specific grid nodes whose hostnames are provided here. Example: If flint is configured on 5 grid nodes and you choose to enable Listener only on 2, then provide their hostnames here like, or,
  • Disabled: Listener will be active only on any one of the configured grid nodes.
Config (JSON)Parameters specified here are specific to the type of Listener used. To add config refer to the documentation, depending upon the type selected.true


The above steps will only add the Listener. To enable the Listener, click on the Actions button against the name of your newly added Listener and select Enable action.

Listener Actions

  1. Enable: Starts the Listener execution. The Listener will start listening to events as soon as it is enabled and take relevant actions accordingly.
  2. Disable: Stops the Listener execution. No events can be listened to and acted upon if a Listener is disabled.
  3. Details: Name, Type, Version, Description, High Availability, Status and Worknode of the Connector is shown here.
  4. Edit/Manage: You can change the configuration parameters here.
  5. Delete: Completely removes the Listener from Flint

To enable/disable multiple Listeners, use Bulk Action

On this page:

  • No labels