HTTP API

Supports:

✅ Models

Connection

Configuration

Name	Type	Description	Required
`auth`	`object`	Authentication method	`optional`
`body`	`string`	JSON payload	`optional`
`headers`	`array`	Headers	`optional`
`healthcheck`	`string`	Health check endpoint Path to request when checking the health of this connection. No health check will be performed if left empty.	`optional`
`parameters`	`array`	Query string parameters	`optional`
`url`	`string`	Base URL	`required`

Example

{
  "name": "HTTP API connection",
  "type": "api",
  "configuration": {
    "auth": {
        "basic": {
            "password": "secret",
            "username": "user@example.com"
        },
        "header": {
            "name": "foo",
            "value": "bar"
        },
        "oauth": {
            "auth_style": 0,
            "client_id": "client_id",
            "client_secret": "client_secret",
            "extra_form_data": [
                {
                    "name": "foo",
                    "value": "bar"
                }
            ],
            "scopes": [],
            "token_endpoint": "https://example.com/oauth/token"
        },
        "query": [
            {
                "name": "foo",
                "value": "bar"
            }
        ]
    },
    "body": "{\"key\":\"value\"}",
    "headers": [
        {
            "name": "foo",
            "value": "bar"
        }
    ],
    "healthcheck": "https://example.com/healthz",
    "parameters": [
        {
            "name": "foo",
            "value": "bar"
        }
    ],
    "url": "https://example.com"
  }
}

Model Sync

Source

Configuration

Name	Type	Description	Required
`body`	`string`	Request body	`optional`
`headers`	`object`	Headers	`optional`
`method`	`string`	Method Accepted values: `GET`, `POST`	`required`
`pagination`	`object`	Pagination	`optional`
`parameters`	`object`	Parameters	`optional`
`path`	`string`	Path	`optional`
`record_path`	`string`	Record JSON path	`optional`
`sampleResponse`	`string`	API response	`optional`

Example

{
  ...
  "configuration": {
    "body": "",
    "headers": {},
    "method": "GET",
    "pagination": {},
    "parameters": {},
    "path": "",
    "record_path": "",
    "sampleResponse": ""
  }
}