Create a Destination

post

https://us.hevodata.com/api/v2/destinations

Creates a Destination with the configuration settings that you provide. The settings that a Destination accepts depend on its connector. Call the Get Configuration Details of a Destination Connector endpoint to read the JSON schema of the request body, which states every config key, its data type, and whether and when it is required.

Hevo tests the connection before saving the Destination, and the call returns only after that test finishes. If Hevo cannot connect to the Destination, the request returns a 400 that includes the message from the connector, and the Destination is not created.

Read Creating Destinations with Hevo API for the steps to create a Destination.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

Unique name for your Destination, not exceeding 255 characters. The name must start with a letter or a digit, and can contain only letters, digits, spaces, hyphens (-) and underscores (_). Hevo removes any leading and trailing spaces before it checks the name. The name must be unique across your team, including the Destinations in other regions that this endpoint does not list. You can reuse the name of a Destination that you have deleted.

connector_id

string

required

Unique identifier of the connector that you want to use for this Destination. Retrieve this value from the List All Destination Connectors endpoint. Send this value exactly as that endpoint returns it.

type

string

(Optional) Type of the Destination. If you send this value, it must identify the same connector as the connector_id value.

config

object

required

Configuration settings for the Destination. Credentials are accepted here and are masked in every response. Read the settings that your connector accepts from the Get Configuration Details of a Destination Connector endpoint. Refer to Creating Destinations with Hevo API for more information about the settings of each Destination.

Responses

400

The Destination could not be created. This occurs when:

name or config is missing.
The name value is not valid, or another Destination already uses it.
The connector_id value is not valid, or the type value does not match it.
A config key fails validation.
The connection test fails.
The connector is in beta and has not been enabled for your team.

403

You do not have the permission to create a Destination. Ask your team administrator for a role that allows it.

500

Hevo could not complete the request. If the connection test is still running after five minutes, nothing is created. If Hevo saves the Destination but its setup then fails, the Destination is left in the FAILED status. Delete it and create it again. The response returns an error_reference_id value that you can quote to Hevo Support.

200Destination created successfully.