Get Configuration Details of a Destination Connector

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 required must 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/then block inside allOf, and is required only when that condition is met.
  • A credential is a string marked writeOnly: true and format: 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 oneOf list of const values, each with its display name in title.
  • 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the connector, as returned by the List All Destination Connectors endpoint. Send this value exactly as that endpoint returns it.

Responses

404

No connector exists with the specified connector_id, or your team does not have access to it.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json