The new External API Integrator tool contains an Endpoints tab which stores API endpoints, methods and an authentication token (either added in Request Header via Custom Parameters or via Request Body). Once the tool is configured, configure an External API Integrator pipeline step that will integrate with their tools to make a RESTful API call.

Tool Registry Setup

1. In Tool Registry, click ‘+ New Tool’ button to create a new External API Integrator tool.

2. Locate the External API Integrator tool and click ‘Select Tool’ button.

   

3. Provide a Tool Name and any other values and click ‘Create’ button to save the new tool.

4. Navigate to the Endpoints tab and click the ‘+ New External API Integrator Endpoint’ button to configure a new Endpoint.

...

The External API Integrator tool can now be configured in a pipeline step.

Follow these guidelines to successfully configure an External API Integrator pipeline step in your pipeline.

Pipeline Step Setup

1. In your pipeline

...

1. workflow, create a new step. Provide values for fields in the Step Setup form and select ‘External API Integration’ from the Tool dropdown.

   Image Added

2. Click the ‘Save’ button to save the new tool. Now you can configure the step.

3. Click the gear icon (⚙︎) to open the Pipeline Step Configuration settings.

   Image Added

Pipeline Step Configuration

...

External Api Integrator Tool - Select your configured External API Integrator tool from the dropdown. This is fetched from the Tool Registry.

Endpoint Configuration

Connection Check

The Connection Check rules evaluate the endpoints connection.

API Configuration - To verify the connection, enable the ‘Use Connection Check’ toggle. Select the Connection Check Endpoint configured in your External API Integrator Tool

...

Successful Connection Evaluation Rules -

...