Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

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.

5. Complete the ‘Create New External API Integrator Endpoint’ form.

Name - Provide a custom name for the Endpoint.
Request Type - Select Request Type. Choose from Get, Post or Put.
URL - Provide the respective URL (dependent on Request Type).

6. Provide EndPoint Field Configuration values:


Request Header - If you are required to include a header token, first add it to your Custom Parameters (saved in Tool Registry) and then select it from the dropdown. Custom Parameters are saved in the Tool Registry. Authorization Tokens must be encrypted Custom Parameters. Do not include "Bearer" in the Custom Parameter. This field is not required if you have an API token. You can add the API token to Request Body.


Request Body - To add a field, click the ‘+ Add Field’ button. Provide a Field Name and a Field Type (Sting, Array, Date). API token can be added here.


Response Body - Select a Response Body Type from the dropdown (Array, Boolean, Object or String).
Response Body Fields - Click ‘+ Add Field’ button to add. Add Field Name and Field Type (String, Array or Date) for each response body field.

7. Provide a Description for the Endpoint (optional).

8. Click the ‘Create’ button to save the 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 workflow, create a new step. Provide values for fields in the Step Setup form and select ‘External API Integration’ from the Tool dropdown.

  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.

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 -

Run Trigger

The Run Trigger rules evaluate the API call as it is in progress.

API Configuration -

In Progress Evaluation Rules -

Successful Trigger Evaluation Rules -

Status Check

The Status Check rules evaluate the API call upon completion.

API Configuration -

In Progress Evaluation Rules -

Successful Completion Evaluation Rules -

  • No labels