Font Size:

API Connector Process Tool plugin

Introduction

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

Get started

  1. In Process Builder, click the Tool component in the participant track.
  2. For Tools, select API Connector from the drop-down list.
  3. Configure the API connector properties and click Apply Change.

Properties configuration

 

  • 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 Name: Specify the field name.
    • JSON Object Name: Specify the corresponding JSON object 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.
        • Status (Create Account)
        • status (basicinfo Approval Process, basicinfo Approval Approval Process)
    • JSON Object Name: Links the variable or status to the JSON object.

 

Related documentation

 
Created by Debanraj Last modified by Aadrian on Apr 30, 2025