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
GET routeInputGet
Get all information about a single route input ([event listeners](/docs/serverless/events-and-actions/overview#event-listeners)).
PUT routeInputPut
Update information for a single route input ([event listener](/docs/serverless/events-and-actions/overview#event-listeners)).
DELETE routeInputDelete
Delete all information available for a single route input ([event listener](/docs/serverless/events-and-actions/overview#event-listeners)).
GET routeInputsGetAll
Get information about all previously created inputs ([event listeners](/docs/serverless/events-and-actions/overview#event-listeners)).
POST routeInputCreate
Create a single route input ([event listener](/docs/serverless/events-and-actions/overview#event-listeners)) to listen for messages (events) from a given producer (such as Pub/Sub API, Presence API, or Push Notifications API).