HTTP API

Supports:

✅ Models

Connection

Configuration

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

Example

1 {
2   "name": "HTTP API connection",
3   "type": "api",
4   "configuration": {
5     "auth": {
6         "basic": {
7             "password": "secret",
8             "username": "user@example.com"
9         },
10         "header": {
11             "name": "foo",
12             "value": ""
13         },
14         "oauth": {
15             "auth_style": 0,
16             "client_id": "client_id",
17             "client_secret": "client_secret",
18             "extra_form_data": [
19                 {
20                     "name": "foo",
21                     "value": ""
22                 }
23             ],
24             "scopes": [
25                 {}
26             ],
27             "token_endpoint": "https://example.com/oauth/token"
28         },
29         "query": [
30             {
31                 "name": "foo",
32                 "value": ""
33             }
34         ]
35     },
36     "body": "{\"key\":\"value\"}",
37     "headers": [
38         {
39             "name": "foo",
40             "value": ""
41         }
42     ],
43     "healthcheck": "https://example.com/healthz",
44     "parameters": [
45         {
46             "name": "foo",
47             "value": ""
48         }
49     ],
50     "url": "https://example.com"
51   }
52 }

Model Sync

Source

Configuration

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

Example

1 {
2   ...
3   "configuration": {
4     "body": "",
5     "headers": [
6         {}
7     ],
8     "method": "",
9     "pagination": {},
10     "parameters": [
11         {}
12     ],
13     "path": "",
14     "record_path": "",
15     "sampleResponse": ""
16   }
17 }

1	{
2	"name": "HTTP API connection",
3	"type": "api",
4	"configuration": {
5	"auth": {
6	"basic": {
7	"password": "secret",
8	"username": "user@example.com"
9	},
10	"header": {
11	"name": "foo",
12	"value": ""
13	},
14	"oauth": {
15	"auth_style": 0,
16	"client_id": "client_id",
17	"client_secret": "client_secret",
18	"extra_form_data": [
19	{
20	"name": "foo",
21	"value": ""
22	}
23	],
24	"scopes": [
25	{}
26	],
27	"token_endpoint": "https://example.com/oauth/token"
28	},
29	"query": [
30	{
31	"name": "foo",
32	"value": ""
33	}
34	]
35	},
36	"body": "{\"key\":\"value\"}",
37	"headers": [
38	{
39	"name": "foo",
40	"value": ""
41	}
42	],
43	"healthcheck": "https://example.com/healthz",
44	"parameters": [
45	{
46	"name": "foo",
47	"value": ""
48	}
49	],
50	"url": "https://example.com"
51	}
52	}

1	{
2	...
3	"configuration": {
4	"body": "",
5	"headers": [
6	{}
7	],
8	"method": "",
9	"pagination": {},
10	"parameters": [
11	{}
12	],
13	"path": "",
14	"record_path": "",
15	"sampleResponse": ""
16	}
17	}