HTTP Enrichment

Supports:

✅ Enrichment

Connection

Configuration

Name	Type	Description	Required
`auth`	`object`	Authentication method	`optional`
`example_body`	`string`	Example body to be saved with the query	`optional`
`example_inputs`	`object`	Example inputs to be saved with the connection	`optional`
`fields`	`array`	Fields List of fields to be returned by the enrichment	`optional`
`headers`	`array`	Headers	`optional`
`healthcheck`	`string`	Health check endpoint Path to request when checking the health of this connection. No health check will be performed if left empty.	`optional`
`inputMappings`	`array`	Input variables List of input mappings to be used in the query. Each mapping should be a valid JSONPath expression.	`optional`
`method`	`string`	HTTP method Accepted values: `GET`, `POST` ↓	`required`
`parameters`	`array`	Query string parameters	`optional`
`url`	`string`	Request URL	`required`

`method`

When method is POST:

Name	Type	Description	Required
`body`	`string`	JSON payload	`optional`

{
  "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": "POST",
    "parameters": [
      {
        "name": "foo",
        "value": "bar"
      }
    ],
    "url": "https://example.com"
  }
}

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"
            }
        ]
    },
    "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

Name	Type	Description	Required
`object`	`string`		`optional`

Example

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