POST/destinations

Create a destination

Requires Bearer authentication. See Authentication.

Request body

CreateFromTemplateRequest

fromTemplaterequired object —

`templateId`required	string	—
`templateInputs`required	object (record)	—

namerequired string —

environmentrequired "PRODUCTION" | "STAGING" | "DEVELOPMENT" —

customerAccountIdrequired string (uuid) —

CreateDestinationRequest

type = WEBHOOK

namerequired string —

environmentrequired "PRODUCTION" | "STAGING" | "DEVELOPMENT" —

customerAccountIdrequired string (uuid) —

preflightOverride PreflightOverride —

`status`required	"warn" \| "fail"	—
`reason`required	string	—
`probes`required	string[]	—

typerequired "WEBHOOK" —

configrequired WebhookConfig —

urlrequired string (uri) —

method "POST" | "PUT" —

headers object (record) —

timeout number —

signatureMode "HMAC_SHA256" | "BEARER" —

signing WebhookSigningConfig —

`enabled`	boolean	—
`scheme`	"pushrail_v1" \| "github_v1"	—
`header`	string	—

rateLimitPerSecond integer —

secret string —

deliveryMode "REAL_TIME" —

type = S3

namerequired string —

environmentrequired "PRODUCTION" | "STAGING" | "DEVELOPMENT" —

customerAccountIdrequired string (uuid) —

preflightOverride PreflightOverride —

`status`required	"warn" \| "fail"	—
`reason`required	string	—
`probes`required	string[]	—

typerequired "S3" —

configrequired S3Config —

`bucket`required	string	—
`region`required	string	—
`prefix`	string	—
`pathTemplate`	string	—
`fileFormat`	"JSONL" \| "JSON_ARRAY"	—
`compression`	"NONE" \| "GZIP"	—
`rateLimitPerSecond`	integer	—

secret S3Secret —

`accessKeyId`required	string	—
`secretAccessKey`required	string	—

authMode enum (25) —

authConfig object | AwsAssumeRoleAuthConfig | AwsAssumeRoleAutomatedAuthConfig —

Option 1 · object

No fields.

AwsAssumeRoleAuthConfig

roleArnrequired string —

AwsAssumeRoleAutomatedAuthConfig

awsAccountIdrequired string —

deliveryMode "BATCHED" —

batchConfig BatchConfig —

`flushIntervalSeconds`	number	—
`maxBatchSize`	number	—
`maxBatchBytes`	number	—

type = GCS

namerequired string —

environmentrequired "PRODUCTION" | "STAGING" | "DEVELOPMENT" —

customerAccountIdrequired string (uuid) —

preflightOverride PreflightOverride —

`status`required	"warn" \| "fail"	—
`reason`required	string	—
`probes`required	string[]	—

typerequired "GCS" —

configrequired GCSConfig —

`bucket`required	string	—
`prefix`	string	—
`pathTemplate`	string	—
`fileFormat`	"JSONL" \| "JSON_ARRAY"	—
`compression`	"NONE" \| "GZIP"	—
`rateLimitPerSecond`	integer	—

secret BigQuerySecret —

serviceAccountKeyrequired string —

authMode enum (25) —

authConfig object | AwsAssumeRoleAuthConfig | AwsAssumeRoleAutomatedAuthConfig —

Option 1 · object

No fields.

AwsAssumeRoleAuthConfig

roleArnrequired string —

AwsAssumeRoleAutomatedAuthConfig

awsAccountIdrequired string —

oauthAuthorizationId string (uuid) —

deliveryMode "BATCHED" —

batchConfig BatchConfig —

`flushIntervalSeconds`	number	—
`maxBatchSize`	number	—
`maxBatchBytes`	number	—

type = BIGQUERY

namerequired string —

environmentrequired "PRODUCTION" | "STAGING" | "DEVELOPMENT" —

customerAccountIdrequired string (uuid) —

preflightOverride PreflightOverride —

`status`required	"warn" \| "fail"	—
`reason`required	string	—
`probes`required	string[]	—

typerequired "BIGQUERY" —

configrequired BigQueryConfig —

projectIdrequired string —

datasetIdrequired string —

tableIdrequired string —

schemaMappingrequired object —

columnsrequired array —

`sourceField`required	string	—
`columnName`required	string	—
`columnType`required	enum (6)	—
`required`	boolean	—
`defaultValue`	any	—

includeMetadata boolean —

unmappedFieldBehavior "IGNORE" | "STORE_AS_JSON" —

insertMethod "STREAMING" | "LOAD_JOB" —

createTableIfNotExists boolean —

partitionField string —

rateLimitPerSecond integer —

secret BigQuerySecret —

serviceAccountKeyrequired string —

authMode enum (25) —

authConfig object | AwsAssumeRoleAuthConfig | AwsAssumeRoleAutomatedAuthConfig —

Option 1 · object

No fields.

AwsAssumeRoleAuthConfig

roleArnrequired string —

AwsAssumeRoleAutomatedAuthConfig

awsAccountIdrequired string —

oauthAuthorizationId string (uuid) —

deliveryMode "BATCHED" —

batchConfig BatchConfig —

`flushIntervalSeconds`	number	—
`maxBatchSize`	number	—
`maxBatchBytes`	number	—

type = SNOWFLAKE

namerequired string —

environmentrequired "PRODUCTION" | "STAGING" | "DEVELOPMENT" —

customerAccountIdrequired string (uuid) —

preflightOverride PreflightOverride —

`status`required	"warn" \| "fail"	—
`reason`required	string	—
`probes`required	string[]	—

typerequired "SNOWFLAKE" —

configrequired SnowflakeConfig —

accountrequired string —

warehouserequired string —

databaserequired string —

schemarequired string —

tablerequired string —

schemaMappingrequired object —

columnsrequired array —

`sourceField`required	string	—
`columnName`required	string	—
`columnType`required	enum (6)	—
`required`	boolean	—
`defaultValue`	any	—

includeMetadata boolean —

unmappedFieldBehavior "IGNORE" | "STORE_AS_JSON" —

loadMethod "STAGE_COPY" | "SNOWPIPE" —

stageNamerequired string —

rateLimitPerSecond integer —

secret object —

`username`required	string	—
`password`	string	—
`privateKey`	string	—
`privateKeyPassphrase`	string	—

authMode enum (25) —

oauthAuthorizationId string (uuid) —

deliveryMode "BATCHED" —

batchConfig BatchConfig —

`flushIntervalSeconds`	number	—
`maxBatchSize`	number	—
`maxBatchBytes`	number	—

type = POSTHOG

namerequired string —

environmentrequired "PRODUCTION" | "STAGING" | "DEVELOPMENT" —

customerAccountIdrequired string (uuid) —

preflightOverride PreflightOverride —

`status`required	"warn" \| "fail"	—
`reason`required	string	—
`probes`required	string[]	—

typerequired "POSTHOG" —

configrequired PosthogConfig —

host string (uri) —

distinctIdField string —

eventNameField string —

timestampField string —

propertiesField string —

groupsMapping object (record) —

batchConfig object —

`maxRecords`	integer	—
`flushIntervalMs`	integer	—

secretrequired PosthogSecret —

projectApiKeyrequired string —

authMode "POSTHOG_PROJECT_API_KEY" —

deliveryMode "REAL_TIME" | "BATCHED" —

type = KINESIS

namerequired string —

environmentrequired "PRODUCTION" | "STAGING" | "DEVELOPMENT" —

customerAccountIdrequired string (uuid) —

preflightOverride PreflightOverride —

`status`required	"warn" \| "fail"	—
`reason`required	string	—
`probes`required	string[]	—

typerequired "KINESIS" —

configrequired KinesisConfig —

regionrequired string —

streamNamerequired string —

partitionKeyField string —

batchConfig object —

`maxRecords`	integer	—
`flushIntervalMs`	integer	—
`maxBatchBytes`	integer	—

secret AwsStreamSecret —

`accessKeyId`required	string	—
`secretAccessKey`required	string	—
`sessionToken`	string	—

authMode enum (25) —

authConfig object | AwsAssumeRoleAuthConfig | AwsAssumeRoleAutomatedAuthConfig —

Option 1 · object

No fields.

AwsAssumeRoleAuthConfig

roleArnrequired string —

AwsAssumeRoleAutomatedAuthConfig

awsAccountIdrequired string —

deliveryMode "REAL_TIME" | "BATCHED" —

type = SNS

namerequired string —

environmentrequired "PRODUCTION" | "STAGING" | "DEVELOPMENT" —

customerAccountIdrequired string (uuid) —

preflightOverride PreflightOverride —

`status`required	"warn" \| "fail"	—
`reason`required	string	—
`probes`required	string[]	—

typerequired "SNS" —

configrequired SnsConfig —

regionrequired string —

topicArnrequired string —

messageGroupIdField string —

messageDeduplicationIdField string —

messageAttributes object (record) —

batchConfig object —

`maxRecords`	integer	—
`flushIntervalMs`	integer	—

secret AwsStreamSecret —

`accessKeyId`required	string	—
`secretAccessKey`required	string	—
`sessionToken`	string	—

authMode enum (25) —

authConfig object | AwsAssumeRoleAuthConfig | AwsAssumeRoleAutomatedAuthConfig —

Option 1 · object

No fields.

AwsAssumeRoleAuthConfig

roleArnrequired string —

AwsAssumeRoleAutomatedAuthConfig

awsAccountIdrequired string —

deliveryMode "REAL_TIME" | "BATCHED" —

type = SQS

namerequired string —

environmentrequired "PRODUCTION" | "STAGING" | "DEVELOPMENT" —

customerAccountIdrequired string (uuid) —

preflightOverride PreflightOverride —

`status`required	"warn" \| "fail"	—
`reason`required	string	—
`probes`required	string[]	—

typerequired "SQS" —

configrequired SqsConfig —

regionrequired string —

queueUrlrequired string (uri) —

messageGroupIdField string —

messageDeduplicationIdField string —

delaySeconds integer —

batchConfig object —

`maxRecords`	integer	—
`flushIntervalMs`	integer	—

secret AwsStreamSecret —

`accessKeyId`required	string	—
`secretAccessKey`required	string	—
`sessionToken`	string	—

authMode enum (25) —

authConfig object | AwsAssumeRoleAuthConfig | AwsAssumeRoleAutomatedAuthConfig —

Option 1 · object

No fields.

AwsAssumeRoleAuthConfig

roleArnrequired string —

AwsAssumeRoleAutomatedAuthConfig

awsAccountIdrequired string —

deliveryMode "REAL_TIME" | "BATCHED" —

type = PUBSUB

namerequired string —

environmentrequired "PRODUCTION" | "STAGING" | "DEVELOPMENT" —

customerAccountIdrequired string (uuid) —

preflightOverride PreflightOverride —

`status`required	"warn" \| "fail"	—
`reason`required	string	—
`probes`required	string[]	—

typerequired "PUBSUB" —

configrequired PubsubConfig —

projectIdrequired string —

topicrequired string —

orderingKeyField string —

attributesMapping object (record) —

batchConfig object —

`maxRecords`	integer	—
`flushIntervalMs`	integer	—
`maxBatchBytes`	integer	—

secret BigQuerySecret —

serviceAccountKeyrequired string —

authMode enum (25) —

authConfig object | AwsAssumeRoleAuthConfig | AwsAssumeRoleAutomatedAuthConfig —

Option 1 · object

No fields.

AwsAssumeRoleAuthConfig

roleArnrequired string —

AwsAssumeRoleAutomatedAuthConfig

awsAccountIdrequired string —

deliveryMode "REAL_TIME" | "BATCHED" —

type = KAFKA

namerequired string —

environmentrequired "PRODUCTION" | "STAGING" | "DEVELOPMENT" —

customerAccountIdrequired string (uuid) —

preflightOverride PreflightOverride —

`status`required	"warn" \| "fail"	—
`reason`required	string	—
`probes`required	string[]	—

typerequired "KAFKA" —

configrequired KafkaConfig —

brokersrequired string[] —

topicrequired string —

messageKeyField string —

compression enum (5) —

acks "all" | "leader" | "none" —

clientId string —

customHeaders object (record) —

batchConfig object —

`maxRecords`	integer	—
`flushIntervalMs`	integer	—
`maxBatchBytes`	integer	—

secret KafkaSecret —

ClickHousePasswordSecret

`username`required	string	—
`password`required	string	—
`caBundlePem`	string	—

KafkaMtlsSecret

`clientCertPem`required	string	—
`clientKeyPem`required	string	—
`caBundlePem`	string	—

authMode enum (25) —

authConfig object | AwsAssumeRoleAuthConfig | AwsAssumeRoleAutomatedAuthConfig —

Option 1 · object

No fields.

AwsAssumeRoleAuthConfig

roleArnrequired string —

AwsAssumeRoleAutomatedAuthConfig

awsAccountIdrequired string —

deliveryMode "REAL_TIME" | "BATCHED" —

type = POSTGRES

namerequired string —

environmentrequired "PRODUCTION" | "STAGING" | "DEVELOPMENT" —

customerAccountIdrequired string (uuid) —

preflightOverride PreflightOverride —

`status`required	"warn" \| "fail"	—
`reason`required	string	—
`probes`required	string[]	—

typerequired "POSTGRES" —

configrequired PostgresConfig —

hostrequired string —

port integer —

databaserequired string —

schema string —

tablerequired string —

sslMode enum (4) —

columnMapping object (record) —

batchConfig object —

`maxRecords`	integer	—
`flushIntervalMs`	integer	—
`maxBatchBytes`	integer	—

secret ClickHouseSecret —

ClickHousePasswordSecret

`username`required	string	—
`password`required	string	—
`caBundlePem`	string	—

ClickHouseMtlsSecret

`username`required	string	—
`clientCertPem`required	string	—
`clientKeyPem`required	string	—
`caBundlePem`required	string	—

authMode enum (25) —

authConfig object | AwsAssumeRoleAuthConfig | AwsAssumeRoleAutomatedAuthConfig —

Option 1 · object

No fields.

AwsAssumeRoleAuthConfig

roleArnrequired string —

AwsAssumeRoleAutomatedAuthConfig

awsAccountIdrequired string —

deliveryMode "BATCHED" —

type = MYSQL

namerequired string —

environmentrequired "PRODUCTION" | "STAGING" | "DEVELOPMENT" —

customerAccountIdrequired string (uuid) —

preflightOverride PreflightOverride —

`status`required	"warn" \| "fail"	—
`reason`required	string	—
`probes`required	string[]	—

typerequired "MYSQL" —

configrequired MySqlConfig —

hostrequired string —

port integer —

databaserequired string —

schemarequired string —

tablerequired string —

sslMode enum (4) —

columnMapping object (record) —

batchConfig object —

`maxRecords`	integer	—
`flushIntervalMs`	integer	—
`maxBatchBytes`	integer	—

secret ClickHouseSecret —

ClickHousePasswordSecret

`username`required	string	—
`password`required	string	—
`caBundlePem`	string	—

ClickHouseMtlsSecret

`username`required	string	—
`clientCertPem`required	string	—
`clientKeyPem`required	string	—
`caBundlePem`required	string	—

authMode enum (25) —

authConfig object | AwsAssumeRoleAuthConfig | AwsAssumeRoleAutomatedAuthConfig —

Option 1 · object

No fields.

AwsAssumeRoleAuthConfig

roleArnrequired string —

AwsAssumeRoleAutomatedAuthConfig

awsAccountIdrequired string —

deliveryMode "BATCHED" —

type = CLICKHOUSE

namerequired string —

environmentrequired "PRODUCTION" | "STAGING" | "DEVELOPMENT" —

customerAccountIdrequired string (uuid) —

preflightOverride PreflightOverride —

`status`required	"warn" \| "fail"	—
`reason`required	string	—
`probes`required	string[]	—

typerequired "CLICKHOUSE" —

configrequired ClickHouseConfig —

hostrequired string —

port integer —

databaserequired string —

tablerequired string —

sslMode enum (4) —

format "JSONEachRow" | "JSONCompactEachRow" —

async_insert boolean —

columnMapping object (record) —

batchConfig object —

`maxRecords`	integer	—
`flushIntervalMs`	integer	—
`maxBatchBytes`	integer	—

secret ClickHouseSecret —

ClickHousePasswordSecret

`username`required	string	—
`password`required	string	—
`caBundlePem`	string	—

ClickHouseMtlsSecret

`username`required	string	—
`clientCertPem`required	string	—
`clientKeyPem`required	string	—
`caBundlePem`required	string	—

authMode enum (25) —

authConfig object | AwsAssumeRoleAuthConfig | AwsAssumeRoleAutomatedAuthConfig —

Option 1 · object

No fields.

AwsAssumeRoleAuthConfig

roleArnrequired string —

AwsAssumeRoleAutomatedAuthConfig

awsAccountIdrequired string —

deliveryMode "BATCHED" —

type = AZURE_BLOB

namerequired string —

environmentrequired "PRODUCTION" | "STAGING" | "DEVELOPMENT" —

customerAccountIdrequired string (uuid) —

preflightOverride PreflightOverride —

`status`required	"warn" \| "fail"	—
`reason`required	string	—
`probes`required	string[]	—

typerequired "AZURE_BLOB" —

configrequired AzureBlobConfig —

`accountName`required	string	—
`containerName`required	string	—
`prefix`	string	—
`pathTemplate`	string	—
`fileFormat`	"JSONL" \| "JSON_ARRAY"	—
`compression`	"NONE" \| "GZIP"	—
`rateLimitPerSecond`	integer	—

secret AzureConnectionStringSecret | AzureServicePrincipalSecret —

AzureConnectionStringSecret

connectionStringrequired string —

AzureServicePrincipalSecret

`tenantId`required	string (uuid)	—
`clientId`required	string (uuid)	—
`clientSecret`required	string	—

authMode enum (25) —

authConfig object | AwsAssumeRoleAuthConfig | AwsAssumeRoleAutomatedAuthConfig —

Option 1 · object

No fields.

AwsAssumeRoleAuthConfig

roleArnrequired string —

AwsAssumeRoleAutomatedAuthConfig

awsAccountIdrequired string —

deliveryMode "BATCHED" —

batchConfig BatchConfig —

`flushIntervalSeconds`	number	—
`maxBatchSize`	number	—
`maxBatchBytes`	number	—

type = AZURE_SERVICE_BUS

namerequired string —

environmentrequired "PRODUCTION" | "STAGING" | "DEVELOPMENT" —

customerAccountIdrequired string (uuid) —

preflightOverride PreflightOverride —

`status`required	"warn" \| "fail"	—
`reason`required	string	—
`probes`required	string[]	—

typerequired "AZURE_SERVICE_BUS" —

configrequired AzureServiceBusConfig —

`fullyQualifiedNamespace`required	string	—
`entityType`required	"queue" \| "topic"	—
`entityName`required	string	—
`messageIdField`	string	—
`sessionIdField`	string	—
`partitionKeyField`	string	—

secret AzureConnectionStringSecret | AzureServicePrincipalSecret —

AzureConnectionStringSecret

connectionStringrequired string —

AzureServicePrincipalSecret

`tenantId`required	string (uuid)	—
`clientId`required	string (uuid)	—
`clientSecret`required	string	—

authMode enum (25) —

authConfig object | AwsAssumeRoleAuthConfig | AwsAssumeRoleAutomatedAuthConfig —

Option 1 · object

No fields.

AwsAssumeRoleAuthConfig

roleArnrequired string —

AwsAssumeRoleAutomatedAuthConfig

awsAccountIdrequired string —

deliveryMode "REAL_TIME" | "BATCHED" —

type = EVENTBRIDGE

namerequired string —

environmentrequired "PRODUCTION" | "STAGING" | "DEVELOPMENT" —

customerAccountIdrequired string (uuid) —

preflightOverride PreflightOverride —

`status`required	"warn" \| "fail"	—
`reason`required	string	—
`probes`required	string[]	—

typerequired "EVENTBRIDGE" —

configrequired EventBridgeConfig —

`region`required	string	—
`eventBusName`required	string	—
`defaultSource`required	string	—
`defaultDetailType`required	string	—
`sourceField`	string	—
`detailTypeField`	string	—
`resourcesField`	string	—
`traceHeaderField`	string	—

secret S3Secret —

`accessKeyId`required	string	—
`secretAccessKey`required	string	—

authMode enum (25) —

authConfig object | AwsAssumeRoleAuthConfig | AwsAssumeRoleAutomatedAuthConfig —

Option 1 · object

No fields.

AwsAssumeRoleAuthConfig

roleArnrequired string —

AwsAssumeRoleAutomatedAuthConfig

awsAccountIdrequired string —

deliveryMode "REAL_TIME" | "BATCHED" —

type = RABBITMQ

namerequired string —

environmentrequired "PRODUCTION" | "STAGING" | "DEVELOPMENT" —

customerAccountIdrequired string (uuid) —

preflightOverride PreflightOverride —

`status`required	"warn" \| "fail"	—
`reason`required	string	—
`probes`required	string[]	—

typerequired "RABBITMQ" —

configrequired object —

`uri`	string	—
`hosts`	string[]	—
`port`	integer	—
`vhost`	string	—
`exchange`	string	—
`routingKey`required	string	—
`routingKeyField`	string	—
`contentType`	string	—
`persistent`	boolean	—
`messageIdField`	string	—
`headersField`	string	—

secret RabbitMqPlainSecret | RabbitMqMtlsSecret —

RabbitMqPlainSecret

`username`required	string	—
`password`required	string	—
`caCertPem`	string	—

RabbitMqMtlsSecret

`clientCertPem`required	string	—
`clientKeyPem`required	string	—
`caCertPem`	string	—

authMode enum (25) —

authConfig object | AwsAssumeRoleAuthConfig | AwsAssumeRoleAutomatedAuthConfig —

Option 1 · object

No fields.

AwsAssumeRoleAuthConfig

roleArnrequired string —

AwsAssumeRoleAutomatedAuthConfig

awsAccountIdrequired string —

deliveryMode "REAL_TIME" | "BATCHED" —

Responses

201 201

Field Type Description

idrequired string (uuid) —

namerequired string —

typerequired enum (18) —

statusrequired "ACTIVE" | "DISABLED" | "ARCHIVED" —

environmentrequired "PRODUCTION" | "STAGING" | "DEVELOPMENT" —

WebhookConfig

urlrequired string (uri) —

method "POST" | "PUT" —

headers object (record) —

timeout number —

signatureMode "HMAC_SHA256" | "BEARER" —

signing WebhookSigningConfig —

`enabled`	boolean	—
`scheme`	"pushrail_v1" \| "github_v1"	—
`header`	string	—

rateLimitPerSecond integer —

S3Config

`bucket`required	string	—
`region`required	string	—
`prefix`	string	—
`pathTemplate`	string	—
`fileFormat`	"JSONL" \| "JSON_ARRAY"	—
`compression`	"NONE" \| "GZIP"	—
`rateLimitPerSecond`	integer	—

GCSConfig

`bucket`required	string	—
`prefix`	string	—
`pathTemplate`	string	—
`fileFormat`	"JSONL" \| "JSON_ARRAY"	—
`compression`	"NONE" \| "GZIP"	—
`rateLimitPerSecond`	integer	—

BigQueryConfig

projectIdrequired string —

datasetIdrequired string —

tableIdrequired string —

schemaMappingrequired object —

columnsrequired array —

`sourceField`required	string	—
`columnName`required	string	—
`columnType`required	enum (6)	—
`required`	boolean	—
`defaultValue`	any	—

includeMetadata boolean —

unmappedFieldBehavior "IGNORE" | "STORE_AS_JSON" —

insertMethod "STREAMING" | "LOAD_JOB" —

createTableIfNotExists boolean —

partitionField string —

rateLimitPerSecond integer —

SnowflakeConfig

accountrequired string —

warehouserequired string —

databaserequired string —

schemarequired string —

tablerequired string —

schemaMappingrequired object —

columnsrequired array —

`sourceField`required	string	—
`columnName`required	string	—
`columnType`required	enum (6)	—
`required`	boolean	—
`defaultValue`	any	—

includeMetadata boolean —

unmappedFieldBehavior "IGNORE" | "STORE_AS_JSON" —

loadMethod "STAGE_COPY" | "SNOWPIPE" —

stageNamerequired string —

rateLimitPerSecond integer —

PosthogConfig

host string (uri) —

distinctIdField string —

eventNameField string —

timestampField string —

propertiesField string —

groupsMapping object (record) —

batchConfig object —

`maxRecords`	integer	—
`flushIntervalMs`	integer	—

KinesisConfig

regionrequired string —

streamNamerequired string —

partitionKeyField string —

batchConfig object —

`maxRecords`	integer	—
`flushIntervalMs`	integer	—
`maxBatchBytes`	integer	—

SnsConfig

regionrequired string —

topicArnrequired string —

messageGroupIdField string —

messageDeduplicationIdField string —

messageAttributes object (record) —

batchConfig object —

`maxRecords`	integer	—
`flushIntervalMs`	integer	—

SqsConfig

regionrequired string —

queueUrlrequired string (uri) —

messageGroupIdField string —

messageDeduplicationIdField string —

delaySeconds integer —

batchConfig object —

`maxRecords`	integer	—
`flushIntervalMs`	integer	—

PubsubConfig

projectIdrequired string —

topicrequired string —

orderingKeyField string —

attributesMapping object (record) —

batchConfig object —

`maxRecords`	integer	—
`flushIntervalMs`	integer	—
`maxBatchBytes`	integer	—

KafkaConfig

brokersrequired string[] —

topicrequired string —

messageKeyField string —

compression enum (5) —

acks "all" | "leader" | "none" —

clientId string —

customHeaders object (record) —

batchConfig object —

`maxRecords`	integer	—
`flushIntervalMs`	integer	—
`maxBatchBytes`	integer	—

PostgresConfig

hostrequired string —

port integer —

databaserequired string —

schema string —

tablerequired string —

sslMode enum (4) —

columnMapping object (record) —

batchConfig object —

`maxRecords`	integer	—
`flushIntervalMs`	integer	—
`maxBatchBytes`	integer	—

MySqlConfig

hostrequired string —

port integer —

databaserequired string —

schemarequired string —

tablerequired string —

sslMode enum (4) —

columnMapping object (record) —

batchConfig object —

`maxRecords`	integer	—
`flushIntervalMs`	integer	—
`maxBatchBytes`	integer	—

ClickHouseConfig

hostrequired string —

port integer —

databaserequired string —

tablerequired string —

sslMode enum (4) —

format "JSONEachRow" | "JSONCompactEachRow" —

async_insert boolean —

columnMapping object (record) —

batchConfig object —

`maxRecords`	integer	—
`flushIntervalMs`	integer	—
`maxBatchBytes`	integer	—

AzureBlobConfig

`accountName`required	string	—
`containerName`required	string	—
`prefix`	string	—
`pathTemplate`	string	—
`fileFormat`	"JSONL" \| "JSON_ARRAY"	—
`compression`	"NONE" \| "GZIP"	—
`rateLimitPerSecond`	integer	—

AzureServiceBusConfig

`fullyQualifiedNamespace`required	string	—
`entityType`required	"queue" \| "topic"	—
`entityName`required	string	—
`messageIdField`	string	—
`sessionIdField`	string	—
`partitionKeyField`	string	—

EventBridgeConfig

`region`required	string	—
`eventBusName`required	string	—
`defaultSource`required	string	—
`defaultDetailType`required	string	—
`sourceField`	string	—
`detailTypeField`	string	—
`resourcesField`	string	—
`traceHeaderField`	string	—

Option 18 · object

`uri`	string	—
`hosts`	string[]	—
`port`	integer	—
`vhost`	string	—
`exchange`	string	—
`routingKey`required	string	—
`routingKeyField`	string	—
`contentType`	string	—
`persistent`	boolean	—
`messageIdField`	string	—
`headersField`	string	—

configVersionrequired number —

transformConfigrequired object —

transformsrequired array —

type = rename

`type`required	"rename"	—
`from`required	string	—
`to`required	string	—

type = drop

`type`required	"drop"	—
`field`required	string	—

type = addStatic

`type`required	"addStatic"	—
`field`required	string	—
`value`	any	—

type = mapPath

`type`required	"mapPath"	—
`from`required	string	—
`to`required	string	—

type = selectFields

`type`required	"selectFields"	—
`fields`required	string[]	—

type = wrap

`type`required	"wrap"	—
`wrapper`required	object (record)	—

transformMode "NONE" | "DECLARATIVE" | "SCRIPT" —

activeTransformScriptId string (uuid) —

deliveryModerequired "REAL_TIME" | "BATCHED" —

batchConfigrequired object —

`flushIntervalSeconds`	number	—
`maxBatchSize`	number	—
`maxBatchBytes`	number	—

customerAccountIdrequired string (uuid) —

customerAccountrequired CustomerAccountRef —

`id`required	string (uuid)	—
`externalId`required	string	—
`name`required	string	—

hasSecretrequired boolean —

authModerequired enum (25) —

authConfigrequired object | AwsAssumeRoleAuthConfig | AwsAssumeRoleAutomatedAuthConfig —

Option 1 · object

No fields.

AwsAssumeRoleAuthConfig

roleArnrequired string —

AwsAssumeRoleAutomatedAuthConfig

awsAccountIdrequired string —

permissionAuditAtrequired string (date-time) —

permissionAuditResultrequired object —

`status`required	"clean" \| "over_privileged" \| "error"	—
`checkedAt`required	string (date-time)	—
`extraPermissions`required	string[]	—
`probeErrors`	string[]	—

preflightLastStatus enum (4) —

preflightLastRanAt string (date-time) —

preflightOverriddenAt string (date-time) —

preflightOverrideReason string —

createdAtrequired string (date-time) —

updatedAtrequired string (date-time) —

credential object —

`id`required	string (uuid)	—
`type`required	string	—
`providerAccountEmail`	string	—
`scopes`	string[]	—
`oauthAuthorizationId`	string (uuid)	—
`status`	string	—
`expiresAt`	string (date-time)	—

400 400

Field Type Description

errorrequired object —

`code`required	string	—
`message`required	string	—
`details`	any	—

Errors

Errors use the standard envelope. See Errors for codes, status mappings, and retry semantics.