Add a custom integration step to a Workflow
  • 05 Jun 2024
  • 1 Minute to read
  • Dark
  • PDF

Add a custom integration step to a Workflow

  • Dark
  • PDF

Article summary

A custom integration is a third-party service that can be used to generate and retrieve important information in the course of a Workflow. For example, after obtaining customer information and binding the data to Attributes, a custom integration step can send the information to the third-party service to calculate an exchange rate, insurance premium, or loan payment schedule. The API response data is also bound to Attributes and can be used in subsequent steps in the Workflow. For example, you can insert the calculated insurance premium or payment schedule into a Dynamic Document for your customer to sign or approve.


Custom integrations are created on the Integrations page, see Build a custom integration.

Two paths

The custom integration Workflow item includes two outgoing paths:

  • Success - the API was sent and a response was received

  • Fail - an error occured

You must connect each one of these paths to a different element. For example, connect the Success path to a contract and the Fail path to an alternate contract or to the End of the Workflow.

How to add a custom integration item

To add a custom integration to your Workflow:

  1. From the left pane, drag the Custom integration item onto the canvas.
    The Select custom integration window opens.

  2. Select the relevant custom integration and API endpoint.

    Details of the endpoint appear in the right panel.

  3. Click Select.

    The custom integration item appears on the canvas.

  4. Connect to one item for Pass and one for Fail (see above):

    1. Drag a connector line to the next step in the Workflow.
      The Select result window appears.

    2. Select the result for this path and click Connect.

Edit the custom integration step

After adding the custom integration item to the Workflow canvas, you can select it, and, in the right panel, edit the following:

  • Step name - change the name of the step as it will appear in the interaction tile in the session.

  • Selected API endpoint - change to a different custom integration and/or endpoint.

  • Custom integration response status… - bind the Pass/Fail response of the integration step to a Boolean Attribute.

Use the icons above the selected item to do the following:

  • Duplicate this step

  • Delete this step

Was this article helpful?