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.
| Table of Contents | ||||
|---|---|---|---|---|
|
Tool Registry Setup
In Tool Registry, click ‘+ New Tool’ button to create a new External API Integrator tool.
Locate the External API Integrator tool and click ‘Select Tool’ button.
Provide a Tool Name and any other values and click ‘Create’ button to save the new tool.
Navigate to the Endpoints tab and click the ‘+ New External API Integrator Endpoint’ button to configure a new Endpoint.
...
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.
Click the ‘Save’ button to save the new tool. Now you can configure the step.
Click the gear icon (⚙︎) to open the Pipeline Step Configuration settings.
...
The Connection Check rules evaluate the endpoints Endpoint 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 - Set evaluation rules for Connection Check.
Evaluation Option - Select Response Field Evaluation or Status Code from the dropdown.
Status Code - Evaluate connection based on the status code.
Filter - Either select ‘Is Equal To’ or ‘Is Not Equal To’ from the dropdown.
Value - Provide a value to evaluate.
Response Field Evaluation -
...
Evaluate connection based on the response of evalution rules.
Filter - Choose a selection from the options in the dropdown: ‘This Rule will be successful if any of the field evaluation rules listed below are met’, ‘This Rule will be successful if all of the field evaluation rules listed below are met’, or ‘This Rule will be successful if none of the field evaluation rules listed below are met’.
Field Evaluation Rules - Select Field Names that were provided during Tool setup in Response Body. Evaluate if the connection will be successful based on if the field meets the following requirements ‘Is Not Null’, ‘Does Not Equal’, ‘Is Not Null’, ‘Is Null’:
This field will meet the requirements if [Field Name] - If ‘Equals’ or ‘Not Equals’, provide a value to evaluate based on the response body.
Run Trigger
The Run Trigger rules evaluate the API call as it is in progress.
...