...

1. Click the ‘+ New External API Integrator Endpoint’ button.

   

2. Complete ‘Create New External API Integrator Endpoint’ form

   

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

3. Provide EndPoint Field Configuration values:

   Image Removed

   
   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 ParameteHeader is specifically if you need to include a header token. This field is not required if you have an API token. You can add the API token to Query Parameters.

   Image Added

   
   Query Parameters - 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. if you just got an API token then that would go as a query parameter and not as a header token

   Image Added

   
   Response Body - Select a Response Body Type from the dropdown (Array, Boolean, Object or String).

   Image Added

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

5. Click the ‘Create’ button to save the Endpoint.

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

Pipeline Setup