Configuring your connectionsConnection configurations

HTTP API

Connection

Description

Configuration

NAMETYPEDESCRIPTIONREQUIREDREADONLY
urlstringtruefalse
headersarrayfalsefalse
bodystringfalsefalse
parametersarrayfalsefalse
healthcheckstringPath to request when checking the health of this connection. No health check will be performed if left empty.falsefalse
authobjectfalsefalse

Example

1{
2 "name": "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 "client_id": "client_id",
16 "client_secret": "client_secret",
17 "extra_form_data": [
18 {
19 "name": "foo",
20 "value": ""
21 }
22 ],
23 "token_endpoint": "https://example.com/oauth/token"
24 }
25 },
26 "body": "{\"key\":\"value\"}",
27 "headers": [
28 {
29 "name": "foo",
30 "value": ""
31 }
32 ],
33 "healthcheck": "https://example.com/healthz",
34 "parameters": [
35 {
36 "name": "foo",
37 "value": ""
38 }
39 ],
40 "url": "https://example.com"
41 }
42}

Model Sync

Source

Configuration

NAMETYPEDESCRIPTIONREQUIREDREADONLY
methodstringAccepted Values: GET, POSTfalsefalse
pathstringfalsefalse
record_pathstringfalsefalse
headersarrayfalsefalse
parametersarrayfalsefalse
bodystringfalsefalse
paginationobjectfalsefalse
sampleResponsestringfalsefalse

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}

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A