Introduction
The API Connector can be used as a tool to be executed upon executing data submission.
Get started
API Connector Form Store plugin
- In Form Builder, navigate to the Settings tab.
- For Save Data To, select API Connector from the drop-down list.
Properties configuration
Save Data To (API Connector): Configure API Connector:
| Name | Description |
|---|---|
| API Connector | Select the API connector created. |
| Auto populate Request Body Payload data? | Automatically fill in the body of an API request with the required data based on predefined rules or configurations. |
| Use Different API For Update | Allows to use a second API method when checked. |
| API Connector for Update | Select a different API connector created. |
| Handling for Field Workflow Variable? | Update workflow variable on form field. Not applicable for grid elements. |
| Handling for Uploaded Files? | Store uploaded files to "app_formuploads" based on form properties table name. |
Once an API Connector is selected, the API Connector (<API Connector>) section is displayed. These following properties to configure:
Here’s the information in a structured table:
| Name | Description |
|---|---|
| Select Operation | Select a PUT or POST operation created in the API Connector Builder. |
| Description | A description of the API Connector Builder. |
| Payload | Define the structure of the API in JSON or YAML format. Can include details like authentication methods, request parameters, query parameters, or more complex schemas. |