Destination
Create a new destination
- Documentation
- Contact Us
- Introduction
- Link Token
- Sync
- Destination
- Source
- Object
- Connection
- Customer Data
Overview
API Reference
Destination
Create a new destination
POST
/
destination
X-API-KEY
string
*
X-API-KEY
Required
string
object
*
display_name
string
*
display_name
Required
string
Add Example Value
connection_type
enum<string>
*
connection_type
Required
enum<string>
bigquery_config
object
bigquery_config
object
credentials
string
credentials
string
Add Example Value
location
string
*
location
Required
string
Add Example Value
snowflake_config
object
snowflake_config
object
username
string
*
username
Required
string
Add Example Value
password
string
*
password
Required
string
Add Example Value
warehouse_name
string
*
warehouse_name
Required
string
Add Example Value
database_name
string
*
database_name
Required
string
Add Example Value
host
string
*
host
Required
string
Add Example Value
role
string
*
role
Required
string
Add Example Value
redshift_config
object
redshift_config
object
username
string
*
username
Required
string
Add Example Value
password
string
*
password
Required
string
Add Example Value
database_name
string
*
database_name
Required
string
Add Example Value
host
string
*
host
Required
string
Add Example Value
port
string
*
port
Required
string
Add Example Value
mongodb_config
object
mongodb_config
object
username
string
*
username
Required
string
Add Example Value
password
string
*
password
Required
string
Add Example Value
host
string
*
host
Required
string
Add Example Value
connection_options
string
connection_options
string
Add Example Value
Authorizations
X-API-KEY
string
headerrequiredBody
application/json
display_name
string
requiredconnection_type
enum<string>
requiredAvailable options:
snowflake
, bigquery
, redshift
, mongodb
, webhook
bigquery_config
object
bigquery_config.credentials
string
bigquery_config.location
string
requiredsnowflake_config
object
snowflake_config.username
string
requiredsnowflake_config.password
string
requiredsnowflake_config.warehouse_name
string
requiredsnowflake_config.database_name
string
requiredsnowflake_config.host
string
requiredsnowflake_config.role
string
requiredredshift_config
object
redshift_config.username
string
requiredredshift_config.password
string
requiredredshift_config.database_name
string
requiredredshift_config.host
string
requiredredshift_config.port
string
requiredmongodb_config
object
mongodb_config.username
string
requiredmongodb_config.password
string
requiredmongodb_config.host
string
requiredmongodb_config.connection_options
string
Response
200 - application/json
destination
object
destination.id
integer
destination.display_name
string
destination.connection
object
destination.connection.id
integer
destination.connection.connection_type
enum<string>
Available options:
snowflake
, bigquery
, redshift
, mongodb
, webhook