HTTP Enrichment

Supports:

✅ Enrichment

Connection

Configuration

Name	Type	Description	Required
`auth`	`object`	Authentication method	`false`
`body`	`string`	JSON payload	`false`
`example_body`	`string`	Example body to be saved with the query	`false`
`example_inputs`	`object`	Example inputs to be saved with the connection	`false`
`fields`	`array`	Fields List of fields to be returned by the enrichment	`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`
`inputMappings`	`array`	Input mappings List of input mappings to be used in the query. Each mapping should be a valid JSONPath expression.	`false`
`method`	`string`	HTTP Method Accepted values: `GET`, `POST`	`true`
`parameters`	`array`	Query string parameters	`false`
`url`	`string`	Base URL	`true`

Example

1 {
2   "name": "HTTP Enrichment connection",
3   "type": "httpenrichment",
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     "example_body": "",
38     "example_inputs": {},
39     "fields": [
40         {
41             "name": "",
42             "path": "",
43             "type": ""
44         }
45     ],
46     "headers": [
47         {
48             "name": "foo",
49             "value": ""
50         }
51     ],
52     "healthcheck": "https://example.com/healthz",
53     "inputMappings": [
54         {
55             "name": "",
56             "required": false,
57             "type": ""
58         }
59     ],
60     "method": "",
61     "parameters": [
62         {
63             "name": "foo",
64             "value": ""
65         }
66     ],
67     "url": "https://example.com"
68   }
69 }

Model Sync

Enrichment

Configuration

Name	Type	Description	Required
`object`	`string`		`false`

Example

1 {
2   ...
3   "configuration": {
4     "object": ""
5   }
6 }

1	{
2	"name": "HTTP Enrichment connection",
3	"type": "httpenrichment",
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	"example_body": "",
38	"example_inputs": {},
39	"fields": [
40	{
41	"name": "",
42	"path": "",
43	"type": ""
44	}
45	],
46	"headers": [
47	{
48	"name": "foo",
49	"value": ""
50	}
51	],
52	"healthcheck": "https://example.com/healthz",
53	"inputMappings": [
54	{
55	"name": "",
56	"required": false,
57	"type": ""
58	}
59	],
60	"method": "",
61	"parameters": [
62	{
63	"name": "foo",
64	"value": ""
65	}
66	],
67	"url": "https://example.com"
68	}
69	}