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


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

FeatureDetails
API ConnectorSelect 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).
PayloadDefine the structure of the API in JSON or YAML format (POST and PUT methods).
FormSelect a form to store the data to.
Base JSON Object NameSelect 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

  • FIELD NAME
  • JSON OBJECT NAME
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 NameLinks the variable or status to the JSON object.

Related documentation

  • No labels