Connection capability

Proxy API Request

Connect an approved third-party API when a dedicated integration is not available.

Description

AIM AI can be configured to send a bounded HTTP request to an approved endpoint from a defined workflow. The destination, method, credentials, fields, timeout, error handling, and data policy are confirmed before implementation.

Authentication

Authentication may use a bearer token, basic authentication, an API-key header, or no credential, depending on the approved endpoint.
Exact destinations, secrets, network rules, and approved actions are confirmed during workflow scoping.

Supported Actions (5)

These are the operations this integration can perform after the required credentials and permissions are approved.

POST JSON
Async (for slow targets)
GET with Query
PUT JSON
DELETE

Examples

Use these representative payloads as a technical starting point, then replace the sample values with the approved workflow data.

Proxy - POST JSON

Representative workflow configuration for Proxy - POST JSON.

JSON

{
  "automationType": "proxy",
  "nodeId": "proxy-post-001",
  "nodeParams": {
    "params": {
      "apiMethod": "POST",
      "apiURL": "https://httpbin.org/post",
      "authenticationSelect": "Bearer Token",
      "bearerToken": "webhook-secret-token-123",
      "contentType": "application/json",
      "responseType": "json",
      "enableHeaders": true,
      "headers": [
        {
          "name": "X-Webhook-Source",
          "value": "aim-ai-automation"
        }
      ],
      "requestBody": true,
      "requestBodyJson": {
        "event_type": "purchase_completed",
        "user_id": "user-123",
        "transaction_id": "txn-abc123",
        "amount": 9.99,
        "currency": "USD"
      },
      "timeoutMs": 55000
    }
  }
}

Proxy - Async (for slow targets)

Representative workflow configuration for Proxy - Async (for slow targets).

JSON

{
  "automationType": "proxy",
  "async": true,
  "callbackUrl": "https://your-app.com/api/automation/callback",
  "nodeId": "proxy-async-001",
  "nodeParams": {
    "params": {
      "apiMethod": "POST",
      "apiURL": "https://api.aim-ai.example/v1/lead/sendtoworkflow",
      "authenticationSelect": "Bearer Token",
      "bearerToken": "YOUR_TOKEN",
      "contentType": "application/json",
      "responseType": "json",
      "enableHeaders": false,
      "requestBody": true,
      "requestBodyJson": {
        "workflow_id": "...",
        "lead_id": "...",
        "record": []
      },
      "timeoutMs": 120000
    }
  }
}

Proxy - GET with Query

Representative workflow configuration for Proxy - GET with Query.

JSON

{
  "automationType": "proxy",
  "nodeId": "proxy-get-001",
  "nodeParams": {
    "params": {
      "apiMethod": "GET",
      "apiURL": "https://httpbin.org/get",
      "authenticationSelect": "None",
      "contentType": "application/json",
      "responseType": "json",
      "enableHeaders": true,
      "headers": [
        {
          "name": "Accept",
          "value": "application/json"
        }
      ],
      "requestBody": false,
      "queryParams": {
        "user_id": "user-123",
        "include_metadata": "true"
      },
      "timeoutMs": 55000
    }
  }
}

Proxy - PUT JSON

Representative workflow configuration for Proxy - PUT JSON.

JSON

{
  "automationType": "proxy",
  "nodeId": "proxy-put-001",
  "nodeParams": {
    "params": {
      "apiMethod": "PUT",
      "apiURL": "https://httpbin.org/put",
      "authenticationSelect": "Bearer Token",
      "bearerToken": "user-api-token",
      "contentType": "application/json",
      "responseType": "json",
      "enableHeaders": true,
      "headers": [
        {
          "name": "X-Update-Source",
          "value": "automation"
        }
      ],
      "requestBody": true,
      "requestBodyJson": {
        "preferences": {
          "email": true,
          "sms": false
        }
      },
      "timeoutMs": 55000
    }
  }
}

Proxy - DELETE

Representative workflow configuration for Proxy - DELETE.

JSON

{
  "automationType": "proxy",
  "nodeId": "proxy-delete-001",
  "nodeParams": {
    "params": {
      "apiMethod": "DELETE",
      "apiURL": "https://httpbin.org/delete",
      "authenticationSelect": "Bearer Token",
      "bearerToken": "admin-api-token",
      "contentType": "application/json",
      "responseType": "json",
      "enableHeaders": true,
      "headers": [
        {
          "name": "X-Delete-Reason",
          "value": "automation_cleanup"
        }
      ],
      "requestBody": false,
      "queryParams": {
        "force": "true"
      },
      "timeoutMs": 55000
    }
  }
}