Integration Node - Automate Third-party Integrations

The Integration node allows you to connect to a third-party service provider within the Tool Flow using the configured connection and auth method from the Settings console. Learn more.

Note

• You must add at least one connection to configure the node. Learn more.
• Make sure the selected connection is tested under Settings > Integrations before using it in the node. Learn more.

When you select a connection, the node allows you to add specific actions provided by the third-party service, such as exporting data from a site or fetching broken backlinks into your tool automation flow.

You can configure the required action parameters directly in the UI, or view and copy the JSON code generated for the configured node.

Benefits

• Prebuilt services or actions can be embedded into your automation flow without any coding.

• These services are secured through the authentication mechanism of the configured and tested connection.

• You can easily customize the node in the Tool Flow canvas and integrate it with other nodes to suit your specific needs.

Steps to Add and Configure the Node

Prerequisite

A service provider account and connection to it must exist before you configure a node. If no connection is available, the system will prompt you to add one.

To add a connection, click + Add Connection. The system redirects to Settings > Integrations page. Follow the steps here to complete the process.

To add and configure the Integration node, follow the steps below:

1. On the Tools tab, click the name of the tool to which you want to add the node. The Tool Flow page is displayed.

2. Click Go to flow to edit the in-development version of the flow.

3. In the flow builder, click Integration > + New Integration in the Assets panel. Alternatively, drag the node from the panel onto the canvas. You can also click Integration in the pop-up menu.

4. In the Integration window, either search for the required service or select from the listed options. See the list of supported pre-built integrations.

5. Click the added node to open its properties dialog box. The General Settings for the node are displayed.

   Note

   The node uses the service provider’s name by default. You can rename the node if needed.

6. Enter or select inputs for the following fields:
• Node Name: Enter an appropriate name for the node. For example, “Ahrefslinkbuilder” (Only letters and numbers are allowed).
• Connection Name: Select a connection from the listed options. The list includes all the active connections you have added and configured under Settings > Integrations.

7. Click Add Action to add and configure the required actions or tasks from the service provider.

   Note

   Only one action can be added and configured at a time.

   
8. In the Add Action window, select the required action to be linked to the node.
9. In the action settings window, add inputs for the action fields and click Save. These parameters define how the action is executed for the connection.

   Note

   The action parameters vary depending on the specific action and provider. See the tooltip for more information.

   
10. The added action is listed in the General Properties window of the node. This action is applied to all the connections available for the provider.
11. Click the Connections icon and select Go to Node for success and failure conditions.
• On Success > Go to Node: After the current node is successfully executed, go to a selected node in the flow to execute next, such as an AI node, Function node, Condition node, API node, or End node.
• On Failure > Go to Node: If the execution of the current node fails, go to the End node to display any custom error message from the AI node.

The node connects to the service using the selected connection and performs the configured action when the flow is run.

The next step is to configure and test the flow for the node. Learn more.

Manage Actions

You can either change or edit an action for an integration. However, you cannot delete a configured action directly. To remove an action, you must add a new node and configure it with a different action.

Change Action

To configure a different action, click the Change Action button.

Then, select another action in the Change Action window.

Caution

If you change or replace the existing action, any configuration changes made to the previous action will be lost.

The new action replaces the existing one for the connection. Please configure the action parameters for this action to work properly.

Edit Action

To modify the parameters for an action, follow the steps below:

1. Click the Edit icon.

2. Modify the required values and click Save.

View the JSON Code

In addition to defining action parameters in the configuration window, you can view the related JSON code.

To access the code, enable the JSON switch at the top right of the action configuration window.

This opens a code viewer where you can view the JSON that defines the current action and copy the code. The Integration node executes this action code for the connection when you run the flow.

Configure and Test the Flow for the Node

After adding and configuring the node as mentioned here, follow the steps below to test the flow.

Step 1: (Optional) Add Input Variable(s)

1. Click the Input tab of the Start node, and click Add Input Variable to configure the input for the flow’s test run. Learn more

2. In the Enter input variable window, select the appropriate data type for the Type field to define the input variable.
3. Click Save.

Add all the required input variables to run the flow in the Input section of the Start node.

Step 2: Add Output Variable(s)

This step is required because the Start node must have at least one output parameter linked to the node.

1. Click the Start node and select the Output tab.
2. Click Add Output Variable.

3. Enter the value for Name (key) and select String for Type.
4. Click Save. Learn more about accessing the node’s output.

Step 3: Run the Flow

Important

Before running the flow, resolve the tool flow errors that appear when you click the Warning icon.

To run and test the flow, follow the steps below:

1. Click the Run Flow button at the top-right corner of the flow builder.

2. (Optional) Add the value for the Input Variable if you have configured it to test the flow. Otherwise, go directly to the next step.

3. Click Generate Output.

The Debug window generates the flow log and output from the inputs provided. Learn more about running the tool flow.

Access the Node’s Output

The node’s output is stored in a context variable. You can access the variable using the following syntax: {{context.steps.IntegrationNodeName.output}}

Important

Agent Platform can automatically recognize variables and outputs. To do so, type "context.steps." and you will see available variables and nodes, including the nodes' outputs.