Route Inputs Introduction

Route Inputs

This group of endpoints allows you to manage route inputs in the Events & Actions system.

Route Inputs represent event listeners - the entry point for data flowing into your event-driven architecture. They monitor various PubNub APIs and services, capturing events from sources like the Pub/Sub API, Presence API, or Push Notifications API. In the Admin Portal UI, route inputs are referred to as "event listeners".

Key Features:

  • Listen to events from multiple PubNub producers (Pub/Sub, Presence, Push Notifications)
  • Flexible filtering system to narrow down which events trigger your actions
  • State management (ENABLED/DISABLED) for controlling event flow
  • Support for multiple filter types: CONTAINS, EXACT_MATCH, and JSON_PATH
  • Versioned event types for backward compatibility

Filter Types:

  • CONTAINS - Field contains a specific value (partial match)
  • EXACT_MATCH - Field exactly matches a value (full match)
  • JSON_PATH - Advanced filtering using JSONPath expressions for complex event matching

Common Use Cases:

  • Listen for messages on specific channels
  • Monitor when users join or leave channels
  • Track file upload events
  • Capture push notification delivery status