API Connector Process Tool plugin

Introduction

The API Connector Process Tool plugin allows you to integrate external APIs into a process.

Here's the information in a nested table format to enhance clarity:

Name

Details

API Connector

Select the API connector created.

Select Operation

Select the operation created in the API Connector Builder.

Depending on the HTTP method of the operation, configure:

id	Specify the ID of the item to fetch or delete (GET and DELETE methods).
Payload	Define the structure of the API in JSON or YAML format (POST and PUT methods).

Form

Select a form to store the data to.

Base JSON Object Name

Select the name of the base JSON object (e.g., name).

Field Mapping

Allows for manual mapping of a field name to a JSON object name if the names are different

Workflow Variable Mapping

Click Add to configure the following:

Workflow Variable

Variable used in the workflow.

JSON Object Name

Links the variable or status to the JSON object.