Managing listeners

Know how to manage listeners.

1. Go to the project in which you want to create a listener.
2. Click Events > Listeners. All created listeners appear.
3. To enable or disable listeners, do the following steps:
   1. Move the slider on the Enabled/Disabled toggle button in the State column to the right.
      The Configure listener dialog appears.
   2. Enter the replay ID if you want the listener to receive events from a specific replay ID.
      For example, if you have events A, B, C®, and D with replay IDs A1, B1, C1, and D1, and you want to replay everything after event B, enter B’s replay ID (B1) in the Select replay option. If you do not enter any value, then the value that is configured in the Select replay option during listener creation is considered.

      • For new events, enter -1.
      • For all events, enter -2.
   3. Click Enable. The listener is enabled and receives the events based on the replay ID provided.
   After a listener is enabled, connection with the configured streaming APIs is established. Events are received and processed based on the configured flow.

   Note:

   • At times, enabling or disabling a listener might take some time.
   • You can use the messaging functionality to limit the messaging rate for a listener or achieve more precise control over message processing. Configure the flow service that receives messages from Salesforce to publish them to a built-in or external messaging server and create a messaging trigger to process those messages. The messaging trigger can run across multiple nodes to streamline flow invocations and prevent server overload.
   • When the Select replay option is set to Last Received, webMethods Integration saves the replay ID of the most recently received event. During subsequent subscriptions to the channel or topic, Salesforce replays events that are received after the saved event. This configuration helps recover missing events after connection issues and other disruptions.
   • Set the Select replay option to Last Received to ensure reliable event recovery.
   • Listeners that are configured with the Select replay option as New and enabled with a specific replay ID might miss some of the replay events. This miss is in accordance with the current feature design.
   • Salesforce has different allocations for PushTopic, Generic, Change Data Capture, and Platform events based on your license. Make sure that you reviewed the allocations to understand your subscription and consumption limit for your configured solution.
4. To update a listener, click the Edit button available in the Actions column.
   You cannot edit a listener while it is enabled. Also, the channel that you are subscribed to cannot be modified after you created a listener.
5. To remove a listener, click the Delete button available in the Actions column.
   An enabled listener cannot be deleted.
6. To refresh a listener, click the Refresh icon in the Actions column.
   The user interface is not dynamically updated based on the listener status. For example, if a configured listener encounters an error, you might not receive events from Salesforce or the linked integration might not run as expected. During such scenarios, you must manually refresh the listener to make sure that the latest status of the listener is reflected in the user interface.