Skip to main content
Version: 3.4.x

Mock integrations

If you need to test the business process flow but haven't completed all integrations, you can still do so by utilizing the mock integrations server included in the platform.


To begin, configure the microservice's DB settings to use a Postgres DB. Then, deploy the mocked adapter microservice.

Adding a new integration

Setting up a mocked integration requires only one step: adding a mock Kafka request and response.

You have two options for accomplishing this:

  1. Add the information directly to the DB.
  2. Use the provided API.

For each Kafka message exchange between the engine and the integration, you need to create a separate entry.

POST MOCK_ADAPTER_URL/api/kafka-exchanges/

Add new Kafka exchange mock



  • sentMessageJson (string) - the mocked JSON message that the integration will send
  • receivedMessageJson (string) - the JSON message the integration should reply with
  • outgoingTopic (string) - should match the topic the engine listens on for replies from the integration
  • incomingTopic (string) - should match the topic name that the integration listens on


200 - returns the newly added Kafka exchange

GET MOCK_ADAPTER_URL/api/kafka-exchanges/

View all available Kafka exchanges

Retrieves the complete list of all available mocked Kafka exchange messages.






Was this page helpful?