Retrieves the configuration settings that a Destination connector accepts, including their data type, whether they are required, their default value, and the values they allow.
Hevo returns these settings as a JSON schema draft 2020-12 definition, in which the settings specific to the connector are grouped under config. Use this schema to build the request body that you send to the Create a Destination endpoint or in the destination object that you send to the Create a Pipeline endpoint, or to validate it before you send the request.
The schema states the following:
- A key listed under
requiredmust always be sent. A key that Hevo fills with a default value when it is not sent is not required. - A key that applies only under a condition, such as the credentials of a specific authentication method, is defined in an
if/thenblock insideallOf, and is required only when that condition is met. - A credential is a string marked
writeOnly: trueandformat: password. Credentials are accepted while creating a Destination, or when you modify it, and are masked in every response. - A key that accepts a fixed set of values is defined as a
oneOflist ofconstvalues, each with its display name intitle. - If the value of a key must be in a particular format, the key is defined with a
pattern, which is a regular expression that the value must match. Hevo rejects a value that does not match it.
Refer to Read the Connector Configuration for more information about how to read this schema and build a request from it.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
404No connector exists with the specified connector_id, or your team does not have access to it.