Skip to main content

Configure Orchestrate Transaction Listener

Follow these steps to configure and connect to Orchestrate Transaction Listener dependencies:

  1. Configure Apache Kafka (mandatory)
  2. Configure monitoring (optional). Improve the development experience and debugging.
  3. Configure Multi-tenancy (optional). Use Orchestrate with multiple tenants.

In addition to the dependencies, Orchestrate Transaction Listener needs to be configured to connect to the other microservices and to define how the service should be exposed.


Configure each microservice using microservice-specific environment variables. Command line options are also available and take precedence over environment variables.


Environment VariableCommand line optionDescriptionDefault
TX_LISTENER_PROVIDER_REFRESH_INTERVALtx-listener-provider-refresh-intervalTime interval in seconds for refreshing the configuration of registered chains5s
API_URLapi-urlURL of the Gateway API HTTP endpointlocalhost:8081
API_METRICS_URL(only ENV var)URL of the Gateway API HTTP metrics endpoint.localhost:8082
TX_SENTRY_REFRESH_INTERVALtx-sentry-refresh-intervalInterval of time in seconds between checks for pending transactions1s

CLI options

See the complete list of command line options for the Orchestrate Transaction Listener: