HTTP Connector

Overview

A generic outbound HTTPS connector for making arbitrary HTTP calls to any external API. Use it when no dedicated connector exists for the target service, or to call simple webhooks.

Prerequisites

• Base URL for the target API.
• Credentials for one of the four supported auth modes (API key, Basic auth, Bearer token, or OAuth 2.0), or none for public endpoints. Consult the target API's own documentation for how to obtain these.

Authentication

All four auth modes coexist; populate only the one(s) your target API requires. The connector skips blank sections at request time.

API key

Nested api_key config:

Basic auth

Nested basic_auth config:

Bearer token

Nested bearer config:

OAuth 2

Nested oauth2 config:

The connector exchanges credentials for a token at authorization_url and sends Authorization: Bearer <access_token> on the outbound request.

Triggers

None. This connector is outbound only.

Actions

Send HTTP request

Send a custom HTTP request to an external application. Returns the response's status code, headers, and body to the workflow.

Use case: send an HTTP request to an internal or external service.

Input Parameters

Defaults

The connector sends User-Agent: Xurrent iPaaS on every request. Override it by adding a User-Agent entry to headers.

Example Input

{
"method": "GET",
"path": "/users/1",
"headers": [{ "name": "Accept", "value": "application/json" }],
"query_parameters": [{ "name": "include", "value": "profile" }],
"body": null
}

Output

Example Output

{
"response": {
  "status": 200,
  "headers": [
    { "name": "content-type", "value": "application/json" },
    { "name": "x-request-id", "value": "abc-123" }
  ],
  "body": "{\\"id\\":1,\\"name\\":\\"Ada Lovelace\\"}"
}
}

Error Handling

The connector does not retry or back off. The connector returns any HTTP response to the workflow as-is, including 4xx and 5xx. Handle status codes in your runbook (e.g. branch on response.status >= 400). If the connector cannot send the request at all (DNS failure, TLS error, timeout), the action fails with the underlying error.

Best Practices

• Branch on response.status >= 400 in the runbook. The connector never retries and never fails on HTTP error responses.
• Send JSON bodies by setting Content-Type: application/json in headers and passing a stringified JSON body. The connector does not auto-serialise.
• Use one of the four configured auth modes instead of pasting credentials into headers, query_parameters, or body. The platform logs those fields as-is and does not treat them as secrets.
• Prefer a dedicated vendor connector when one exists. HTTP has no pagination helpers, response-body parsing, or rate-limit handling.

Rate Limiting

Outbound requests have a 5-second connect timeout and a 5-minute total request timeout.

Best Practices

• Treat HTTP as a privileged primitive. base_url accepts any URI, including internal hosts, so restrict who can create HTTP connections and review base_url values before enabling.
• Keep base_url narrow (one per external API) so per-connection permissions and audit trails stay meaningful.
• For paginated APIs, iterate in the runbook using the vendor's next/cursor fields from response.body. The connector does not paginate for you.
• Keep body sizes modest. The connector does not stream.

Common Use Cases

• Webhook to an internal service: POST a JSON payload built from workflow inputs, then branch on response.status to confirm delivery.
• Custom REST request: GET, POST, or PATCH a resource on any external REST endpoint, then branch on response.status and parse response.body in the runbook.
• Scheduled cache warm-up: scheduled GET to keep an upstream endpoint's cache warm.
• Outbound notification: POST a summary payload to a chat or alerts webhook.

References

• RFC 9110: HTTP Semantics
• RFC 7617: HTTP Basic Authentication
• RFC 6750: Bearer Token Usage
• RFC 6749: OAuth 2.0