External Events
Overview
The q2-externalevents package provides a wrapper around the External Events service, which is responsible for ingesting external events and triggering downstream actions such as Pinion notifications. The service was designed to provide a standardized framework for handling external events from multiple integrations. While Pinion is currently the only supported downstream destination, the architecture is extensible and may support additional downstream services in the future. To submit an event, populate the appropriate Protobuf message with:
A destination identifying the downstream service that should process the event.
A message describing the event.
An event payload corresponding to one of the supported event types:
AccountEventUserEventTransactionEventBroadcastEvent
Each event also includes an action type that determines how the downstream service should process the request. Supported actions include notification delivery, account refreshes, and transaction reloads.
Supported Destinations
The External Events service currently supports the following downstream destinations:
Getting Started
To install the package, run q2_upgrade and select q2-externalevents. Refer to the destination-specific documentation above for integration examples and configuration requirements.