Perform an API call in Ahoy Movement Studio
Perform an API call in Ahoy Movement Studio. Please refer to the API documentation for more details on configuration.
API doc: https://docs.ahoyams.com/docs
Application
- Ahoy Movement Studio
Inputs (what you have)
| 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 | |
| Method | The HTTP method to be used for the request | Text (Short) | Yes | |
| Request headers | Additional headers to include in the request in JSON format | Text (Long) | No | |
| Request body | The data to be included in the request body | Text (Long) | No | |
| File | A file to be included in the request | File | No | |
| File key | The key where the file will be added to. Defaults to file | Text (Short) | No | |
| Output response as a file? | Select this as true when your API call returns a file as an output | True/False | No |
Outputs (what you get)
| Name | Description | Data Type | Required? | Example |
|---|---|---|---|---|
| Response status code | The HTTP status code returned in the response | Number | Yes | |
| Response headers | Additional information provided in the response headers | Text (Long) | No | |
| Response body | The main content of the response | Text (Long) | No | |
| Downloaded File | A file that is downloaded as part of the response | File | No |
Outcomes
| Name | Description |
|---|---|
| Success | This status is selected if the job has successfully completed. |
| Unsuccessful | This status is selected if the job has completed unsuccessfully. |
Requirements
- N/A