API Workflow Elements

API elements connect workflows to external services. Keep API workflows explicit about input, output, and failure behavior. For long-running calls or retries, prefer an async workflow; see Async Progress and Jobs. For passing sanitized API results through the graph, see Data Flow.

HTTP request (api/http)

Inputs

Port	Type	Description
default	Forward	The input is not used for anything.

Outputs

Port	Type	Description
default	array, File	The request’s response. Type depends on the response type

Request data

Use JSON input for setting up request data, i.e.

• uri
• method
• params
  • base_uri
  • headers
• response_type

Example

{
    "uri": "/track/v1/details/$tracking_number",
    "method": "GET",
    "params": {
        "base_uri": "https://wwwcie.ups.com",
        "headers": {
            "Accept": "application/json",
            "AccessLicenseNumber": "***********"
        }
    },
    "response_type": "json"
}