Skip to navigation

Supports:

  • ✅ Enrichment

Connection

Configuration

NameTypeDescriptionRequired
authobjectAuthentication methodoptional
bodystringJSON payloadoptional
example_bodystringExample body to be saved with the queryoptional
example_inputsobjectExample inputs to be saved with the connectionoptional
fieldsarrayFields

List of fields to be returned by the enrichment
optional
headersarrayHeadersoptional
healthcheckstringHealth check endpoint

Path to request when checking the health of this connection. No health check will be performed if left empty.
optional
inputMappingsarrayInput mappings

List of input mappings to be used in the query. Each mapping should be a valid JSONPath expression.
optional
methodstringHTTP method

Accepted values: GET, POST
required
parametersarrayQuery string parametersoptional
urlstringBase URLrequired

Example

{
"name": "HTTP Enrichment connection",
"type": "httpenrichment",
"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\"}",
"example_body": "",
"example_inputs": {},
"fields": [
{
"name": "",
"path": "",
"type": ""
}
],
"headers": [
{
"name": "foo",
"value": "bar"
}
],
"healthcheck": "https://example.com/healthz",
"inputMappings": [
{
"name": "",
"required": false,
"type": ""
}
],
"method": "GET",
"parameters": [
{
"name": "foo",
"value": "bar"
}
],
"url": "https://example.com"
}
}

Model Sync

Enrichment

Configuration

NameTypeDescriptionRequired
objectstringoptional

Example

{
...
"configuration": {
"object": ""
}
}