Perform an API call
Performs an API call in IntakeQ. Please refer to the API documentation for more details on configuration.
API doc: https://support.intakeq.com/article/31-intakeq-api
Application
- IntakeQ
Inputs (what you have)
For URL-encoded form data, see Sending URL-encoded form data.
| Name | Description | Data Type | Required? | Example |
|---|---|---|---|---|
| Connected Account | The Connected Account to use for the request | Connected Account | Yes | |
| Endpoint | The URL of the API endpoint to access | Text (Long) | Yes | https://intakeq.com/api/v1/clients |
| Method | The HTTP method to be used for the request | Predefined Choice List | Yes | GET |
| Request headers | Additional headers to include in the request in JSON format. The X-Auth-Key header is added automatically from the connected account. | Text (Long) | No | {"Content-Type": "application/json"} |
| Request body | The data to be included in the request body | Text (Long) | No | {"name": "John", "age": 25} |
| File | A file to be included in the request. Note: If a file is added, leave request headers blank and add a filename in your request body. | File | No | example.png |
| Output response as a file? | Select this as true when your API call returns a file as an output | True/False | No |
Note: the value of inputs can either be a set value in the configuration of the Wrk Action within the Wrkflow, or a variable from the Data Library section. These variables in the Data Library section are the outputs of previous Wrk Actions in the Wrkflow.
Outputs (what you get)
| Name | Data Type | Description | Required? | Example |
|---|---|---|---|---|
| Response status code | Integer | The HTTP status code returned in the response | Yes | 200 |
| Response headers | Text (Long) | Additional information provided in the response headers | No | Content-Type: application/json |
| Response body | Text (Long) | The main content of the response | No | {"message": "Success"} |
| Downloaded file | File | A file that is downloaded as part of the response | No | example.pdf |
Note: Use Custom Outputs to create named outputs from this Wrk Action's JSON outputs. Choose the source output and, for Text (short) or Text (long) fields, provide a JSONPath such as $.message; top-level paths remain supported alongside nested and advanced JSONPath expressions.
Outcomes
| Name | Description |
|---|---|
| Success | This status is selected in the event that the API call returns with a status between 200-399 |
| Unsuccessful | This status is selected in the event that the API call returns with a status of 400+ |
| Impossible to Complete | This status is selected in the event of the following scenario:Couldn't resolve hostnameThe external system is not accessible |
Requirements
- An IntakeQ connected account with API access enabled. Find your API key under More → Settings → Integrations → Developer API.