Add New Pipe

This is where users will Add a new Pipe by selecting the system credentials and defining Mapping and Modifier functionalities.

From the Integrations page, click on the Add New button in the top left section to create a new pipe.

The following fields must be filled in order to create a new Integration Pipe:

Pipe Name

Assign a suitable name for the Integration.

Example: Customer Update, Create Order, Fetch Subscription Details

Special characters (except space) cannot be used in the Pipe name.

Pipe Type

Choose the type of Integration: Batch or Dynamic.


Choose Credentials from the drop-down list (Credentials of the Systems that need to be integrated). The credential details have to be already configured. Learn more.


Once the credentials are selected, the Flows with API calls to the systems (Credentials) selected will be displayed in grid format on the right side. Choose a Flow from this grid.

When the Flow is selected, the Mapping nodes associated with the Flow are available to the user to configure.

If systems added in the Flow are selected incorrectly in the Edit pipe page (Credentials drop-down), an error will be thrown to the user alerting that there is a mismatch between Systems added in the Flow and credentials chosen.

If wrong credentials are chosen in the Edit pipe page, the previously configured mapping will be retained. Only if the Flow is changed, previously configured mapping will be removed.


Once the Flow is selected, the associated Mapping nodes are available to the user, i.e., if it has been added in the Flow. Clicking Configure on the Mapping card, opens a Mapping window where the user can map and modify data as required.

Mapping is used to steer data from source to destination systems. Here, the source and destination fields are listed on either side. These fields are taken from the API Manager - Source and Response fields respectively. In addition to these fields, the user can add custom fields as needed.


Project users can add notes for individual pipes using an inbuilt text editor.

Email Alerts at Pipe level

Email alerts can be set for individual pipes.

Click on Email alerts here:

Consider Project Settings: Choosing Yes/No will consider/not consider the email alert settings configured in Project Settings.

  • Yes: The same email alert settings configured at the Project level will be considered for the Pipe

  • No: The email alert settings configured at the Project level will not be considered for the Pipe:

    • Enable Failure Alerts: Select Yes/No to enable failure alerts for this pipe

      • Yes:

        • Select Failure Alert Options:

          • All Failed

          • Partially Failed Only

          • Completely Failed only

        • Email Addresses: Enter the email addresses of recipients to receive failure alerts for this pipe

      • No: Failure alerts will not be triggered at pipe level for this pipe

Read More:

Mapping and ModifiersCreate a new Integration Pipe

Last updated