...
Request Header - If you are required to include a header token, first add it to your the Custom Parameters (saved in Tool Registry) and then select it from the dropdowndrop-down. 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.
...
Response Body - Select a Response Body Type from the dropdown drop-down (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.
...
Follow these guidelines to successfully configure an External API Integrator pipeline step in your the pipeline.
Pipeline Step Setup
In your the pipeline workflow, create a new step. Provide values for fields in the Step Setup form and select ‘External API Integration’ from the Tool dropdown drop-down.
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.
Pipeline Step Configuration
...
External Api API Integrator Tool - Select your a configured External API Integrator tool Tool from the dropdowndrop-down. This is fetched from the Tool Registry.
Endpoint Configuration
Connection Check
...
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Note: Successful Completion Evaluation Rules take precedence over In Progress Evaluation Rules. If the response does NOT match either the Successful Completion OR In Progress Evaluation Rule, it will be considered a failure. The Pipeline will continue running while it meets the In Progress Evaluation Rules until it meets the criteria for Successful Completion or until the Pipeline Run timeout is reached. |
Connection Check, Run Trigger and Status Check
Choose rules to evaluate the Endpoint connections.
API Configuration - To verify the connection, enable the ‘Use Connection Check’ toggle. Select the Connection Check Endpoint configured in your the External API Integrator Tool in the Endpoints tab.
...
Successful Connection Evaluation Rules - Set evaluation rules for Connection Check.
Evaluation Option - Select Response Field Evaluation or Status Code from the dropdowndrop-down.
Status Code - Evaluate connection based on the status code.
Filter - Either select Select ‘Is Equal To’ or ‘Is Not Equal To’ from the dropdowndrop-down.
Value - Provide a value to evaluate.
Response Field Evaluation - Evaluate connection based on the response of evalution evaluation rules. This field will meet the requirements if:
Filter - Choose a selection from the options in the dropdowndrop-down:
‘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’
‘This Rule will be successful if none of the field evaluation rules listed below are met’
Field Evaluation Rules - Select Field Names that were Name (provided during Tool setup in Response Body). Evaluate if the connection will be successful based on if the field Field Name meets the following requirements ‘Is Not Null’, :
‘Equals’
‘Does Not Equal’
‘Is Not Null’
‘Is Null’
This field will meet the requirements if [Field Name] Value - If ‘Equals’ or ‘Not Equals’, provide a value to evaluate based on the response bodyprovided Field Name. Evaluate if the connection will be successful in relation to the Field Evaluation Rules.
Run Trigger
The Run Trigger rules evaluate the API call as it is in progress.
API Configuration
...
:
...
In Progress Evaluation Rules - Set evaluation rules for In Progress Evaluation Rule.
...
Successful Trigger Evaluation Rules - Set evaluation rules for Successful Trigger Evaluation Rule.
...
Status Check
The Status Check rules evaluate the API call upon completion.
API Configuration
...
:
...
In Progress Evaluation Rules
...
:
...
Successful Completion Evaluation Rules
...
:
...