The Plug-In component sends data to an external API endpoint and processes the response. Configure it with a service, define input and output mappings, and set triggers for concurrent, post-execution, and error handling.
How to read settings tables
The tables below describe each configurable option as it displays in the Unqork IDE. Values are formatted as follows:
inline code— a value to type exactly as shown | Bold — a value selected from a drop-down, radio button, tab, or choice chip | ON/OFF — toggle state | ✓ — checkbox checked | ☐ — checkbox unchecked
General Settings
| Setting | Field | Type | Default | Description |
|---|---|---|---|---|
| Property ID | key |
Text input | plug |
The unique identifier for this component instance. |
| Canvas Label Text | label |
Text input | — | Identifies the component on the Module Builder canvas. Does not display. |
Data Settings
Service Type
| Setting | Field | Type | Default | Description |
|---|---|---|---|---|
| Service Type | serviceType |
Drop-down | Unqork | Sets the type of service the component calls. Options include: Unqork for internal Unqork APIs, or External for services configured in Services Administration. |
Service Configuration
The available service selector depends on the Service Type selection.
| Setting | Field | Type | Default | Description |
|---|---|---|---|---|
| Internal Services | unqorkApi |
Service selector | — | Selects the Unqork internal API service and endpoint to call. Visible when Service Type is Unqork. See Internal Services for the full list of available services. |
| External Services | service |
Service selector | — | Selects the external service and endpoint to call. Visible when Service Type is External. |
Endpoint
| Setting | Field | Type | Default | Description |
|---|---|---|---|---|
| Data Source URL | integratorData.integratorUrl |
Text input | — | The API endpoint URL. Auto-populated when a service is selected. |
| Request Type | requestType |
Drop-down | Get | Sets the HTTP method for the API call. Options include: Get, Patch, POST, Put, Delete. See HTTP Request Types. |
Inputs
Defines the data sent to the API. Each row maps a module field to an API input parameter.
| Column | Field | Type | Description |
|---|---|---|---|
| Property ID | id |
Property ID | The module field to send as input. |
| Mapping | mapping |
Text input | The API parameter name this field maps to. |
| Required | required |
☐/✓ | When checked, this setting marks the input as required for the API call. |
| Exclude | exclude |
☐/✓ | When checked, this setting excludes this field from the request body. |
| Header | header |
☐/✓ | When checked, this setting sends this value as an HTTP request header instead of in the body. |
| Resolve Base64 | resolveBase64 |
☐/✓ | When checked, this setting resolves the value as a Base64-encoded string before sending. |
| Optional | optional |
☐/✓ | When checked, this setting marks the input as optional, letting the API call proceed without it. |
Outputs
Defines how the API response is mapped back to module fields.
| Column | Field | Type | Description |
|---|---|---|---|
| Property ID | id |
Property ID | The module field to populate with the response value. |
| Mapping | mapping |
Text input | The property path in the API response to read from. |
| Option | option |
Drop-down | Sets how the output value is applied (for example, set value, append). |
| Header | header |
☐/✓ | When checked, this setting reads the value from an HTTP response header instead of the body. |
Actions Settings
| Setting | Field | Type | Default | Description |
|---|---|---|---|---|
| Trigger Type | triggerType |
Radio button | Manual | Sets when the component executes. • Manual: Waits to be triggered by another component. • Watch: Fires when any input field changes. |
| Concurrent Trigger | preTrigger |
Property ID | — | Triggers another component concurrently while the Plug-In component is executing. |
| Post Trigger | postTrigger |
Property ID | — | Triggers a component after the API call completes successfully. |
| Error Trigger | errorHandler |
Property ID | — | Triggers a component when the API call returns an error. |
| Set Timeout | maxTimeout |
Number input | 120000 |
Maximum time in milliseconds before the API call times out. Accepts values between 0 and 300,000 milliseconds (ms). |
| Number of Retries | retryCount |
Number input | 0 |
Number of times to retry the API call on failure. Accepts values between 0 and 10. |
| ↳ Set Retry Delay | delayBetweenRetries |
Number input | 1000 |
Time in milliseconds to wait between retry attempts. Accepts values between 0 and 10,000 milliseconds (ms). Visible when Number of Retries is greater than 0. |
| Disable Execution | disabled |
Toggle | OFF | Prevents the component from executing when triggered. |
Advanced Settings
| Setting | Field | Type | Default | Description |
|---|---|---|---|---|
| Set Debounce | debounceSetting |
Number input | 500 |
Sets the delay before executing after being triggered, in milliseconds (ms). Useful when multiple components trigger simultaneously. Accepts values between 0 and 500 milliseconds (ms). |
| Show Modal Dialog While Running | modalDialog |
Toggle | OFF | Displays a modal with status text while the API call is in progress. |
| ↳ Processing Title | modalTitle |
Text input | — | The modal heading shown while the API call is running. Visible when Show Modal Dialog While Running is ON. |
| ↳ Processing Message | modalMessage |
Text input | Please wait... |
The modal body text shown while the API call is running. Visible when Show Modal Dialog While Running is ON. |
| ↳ Completion Title | modalSuccess |
Text input | Complete! |
The modal heading shown when the API call completes. Visible when Show Modal Dialog While Running is ON. |
| ↳ Error Message | modalError |
Text input | Error processing... |
The modal text shown when the API call fails. Visible when Show Modal Dialog While Running is ON. |
| Show Page Loading Spinner While Running | showPageSpinner |
Toggle | OFF | Displays a full-page loading spinner while the API call is in progress. |
| Assign Values if They Are Null or Empty String | assignEmptyValues |
Toggle | ON | Sets output fields even when the API response value is null or an empty string. |
| Only Set Output Variables | outputValuesOnly |
Toggle | OFF | Updates only the fields defined in the Outputs table instead of the entire response object. |
| Convert XML Response to JSON | convertXmlResponseToJson |
Toggle | OFF | Converts an XML API response to JSON before processing outputs. |
| Expect Binary Response | expectBinaryResponse |
Toggle | OFF | Processes the response as binary data. The output contains contentType, contentDisposition, and contents keys. |
| Required Property Path in Response | requiredReturnValue |
Text input | — | Logs a console error if the specified property path is not present in the API response. |
| Enable Server Side pagination | enablePagination |
Toggle | OFF | Sends a single page of data at a time. Recommended for large datasets and when using the List submissions for Dashboard service. |
| ↳ Results Per Page | pageSize |
Number input | — | The number of results returned per page. Visible when Enable Server Side Pagination is ON. |
| Synchronous Processing | synchronousProcessing |
Toggle | OFF | Runs the component synchronously instead of running in parallel with other components. |
| Flatten to Single Record Result | allowSingleRecordArray |
Toggle | ON | Extracts nested data and flattens it into a single record object. |
| Assign All Values Returned to Form | assignAllValues |
Toggle | OFF | Writes all values returned by the API directly to the module data object. |
| Use 'data' Value from Response | doNotLookForDataKeyInResponse |
Toggle | ON | Reads the data key from the response object as the result. Turn OFF to use the full response. |
| Include Cookies on Cross-Site Requests | withCredentials |
Toggle | OFF | Sends cookies with cross-site API requests. Required for some authentication scenarios. |
| Disable Input Formula | disableFormulaResolution |
Toggle | OFF | Sends raw string values in inputs without resolving formulas. |
Changelog
| Date | Change |
|---|---|
| — | Initial publication. |