HTTP API

Supports:

  • ✅ Models

Connection

Configuration

NameTypeDescriptionRequired
authobjectAuthentication methodfalse
bodystringJSON payloadfalse
headersarrayHeadersfalse
healthcheckstringHealth check endpoint

Path to request when checking the health of this connection. No health check will be performed if left empty.
false
parametersarrayQuery string parametersfalse
urlstringBase URLtrue

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 },
30 "body": "{\"key\":\"value\"}",
31 "headers": [
32 {
33 "name": "foo",
34 "value": ""
35 }
36 ],
37 "healthcheck": "https://example.com/healthz",
38 "parameters": [
39 {
40 "name": "foo",
41 "value": ""
42 }
43 ],
44 "url": "https://example.com"
45 }
46}

Model Sync

Source

Configuration

NameTypeDescriptionRequired
bodystringRequest Bodyfalse
headersarrayHeadersfalse
methodstringMethod

Accepted values: GET, POST
true
paginationobjectPaginationfalse
parametersarrayParametersfalse
pathstringPathfalse
record_pathstringRecord JSON pathfalse
sampleResponsestringAPI responsefalse

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}