Skip to content
Streamkap
Esc
navigateopen⌘Jpreview

Get Sources

GET/sources
Authorization
AuthorizationBearer token · headerrequired
Query parameters
pageinteger

Page number (1-indexed)

default: 1
page_sizeinteger

Number of results per page (max 100)

default: 10
sortstring | any

Sort field. Can be a DB field (name, created_at) or a metric field (latency, connector_status, recordsLag)

sort_dirSortDirectionEnum

Sort direction: 'asc' (ascending) or 'desc' (descending)

Allowed:ascdesc
last_seen_offsetsstring | object | any

Last seen offsets for topic messages pagination (cursor-based)

first_seen_offsetsstring | object | any

First seen offsets for topic messages pagination (cursor-based)

idstring | any
partial_namestring | any
connectorstring | any

Filter by connector type. Comma-separated for multiple connectors (e.g., 'postgresql', 'postgresql,mysql,mongodb')

statusstring | any

Filter by connector status. Comma-separated for multiple statuses (e.g., 'Active', 'Active,Paused'). Valid statuses: Active, Broken, Paused, Stopped, Starting, Unassigned, Unknown

latencystring | any

Filter by latency in milliseconds. Format: 'operator:value' (e.g., 'gt:1000', 'lt:500', 'gte:100'). Valid operators: gt (>), lt (<), gte (>=), lte (<=), eq (=), ne (!=)

snapshotstring | any

Filter by snapshot status. Comma-separated for multiple statuses (e.g., 'running', 'completed,failed'). Valid statuses: running, completed, failed, pending, cancelled

etastring | any

Filter by snapshot ETA in milliseconds. Format: 'operator:value' (e.g., 'gt:60000', 'lte:300000'). Valid operators: gt (>), lt (<), gte (>=), lte (<=), eq (=), ne (!=). Sources without ETA (null/0) are excluded when filtering.

staleboolean | any

Filter by staleness. true = only sources with no data in 24h, false = only active sources.

tag_idsstring | any

Filter by tag IDs. Comma-separated list (e.g., 'tag1,tag2'). Use with tag_filter_operation to control AND/OR logic.

tag_filter_operationstring | any

Tag filter logic: 'or' (default) matches any tag, 'and' matches all tags.

default: "or"
Request body
application/json
Any of:
SourcesPaginatedReqBody
connectorstring[] | string | any

List of connector types (as array) or comma-separated string. Body takes precedence over query params.

Show properties
Any of:
string[]
Array of string
string
string
string
any
any
statusstring[] | string | any

List of statuses (as array) or comma-separated string. Body takes precedence over query params.

Show properties
Any of:
string[]
Array of string
string
string
string
any
any
snapshotstring[] | string | any

List of snapshot statuses (as array) or comma-separated string. Body takes precedence over query params. Valid statuses: running, completed, failed, pending, cancelled

Show properties
Any of:
string[]
Array of string
string
string
string
any
any
staleboolean | any

Filter by staleness. true = only sources with no data in 24h, false = only active sources. Body takes precedence over query params.

Show properties
Any of:
boolean
boolean
any
any
tag_idsstring[] | string | any

List of tag IDs (as array) or comma-separated string. Body takes precedence over query params.

Show properties
Any of:
string[]
Array of string
string
string
string
any
any
tag_filter_operationstring | any

Tag filter logic: 'or' (default) matches any tag, 'and' matches all tags. Body takes precedence over query params.

Show properties
Any of:
string
string
any
any
any
any
Responses
200

Successful Response

pageinteger

Current page number

default: 1
page_sizeinteger

Results per page

default: 10
totalinteger | any

Total number of results

Show properties
Any of:
integer
integer
any
any
has_nextboolean | any

Whether more pages exist

Show properties
Any of:
boolean
boolean
any
any
resultSourceConnector[]required
Show properties
Array of SourceConnector
namestring | any

User-defined connector name

Show properties
Any of:
string
string
any
any
connectorstring | any

Connector type (e.g., 'postgresql', 'mysql', 'mongodb')

Show properties
Any of:
string
string
any
any
idstring | any

Unique identifier

Show properties
Any of:
string
string
any
any
connector_display_namestring | any

Human-readable connector type name

Show properties
Any of:
string
string
any
any
created_timestampstring | string<date-time> | any

Creation timestamp (ISO 8601)

Show properties
Any of:
string
string
string<date-time>
string<date-time>
any
any
sub_idstring | any

Subscription identifier

Show properties
Any of:
string
string
any
any
tenant_idstring | any

Tenant identifier for multi-tenancy

Show properties
Any of:
string
string
any
any
service_idstring | any

Associated service identifier

Show properties
Any of:
string
string
any
any
configAlloyDBSourceConfig | Db2SourceConfig | DocumentDBSourceConfig | DynamoDBSourceConfig | ElasticSearchSourceConfig | InformixSourceConfig | KafkaDirectSourceConfig | MariaDBSourceConfig | MongoDBSourceConfig | MySQLSourceConfig | OracleSourceConfig | PlanetscaleVitessSourceConfig | PostgreSQLSourceConfig | S3SourceConfig | SQLServerSourceConfig | SalesforceSourceConfig | ShopifySourceConfig | StripeSourceConfig | SupabaseSourceConfig | VitessSourceConfig | WebhookSourceConfig | ZendeskWebhookSourceConfig | any

Connector configuration parameters

Show properties
Any of:
AlloyDBSourceConfig | Db2SourceConfig | DocumentDBSourceConfig | DynamoDBSourceConfig | ElasticSearchSourceConfig | InformixSourceConfig | KafkaDirectSourceConfig | MariaDBSourceConfig | MongoDBSourceConfig | MySQLSourceConfig | OracleSourceConfig | PlanetscaleVitessSourceConfig | PostgreSQLSourceConfig | S3SourceConfig | SQLServerSourceConfig | SalesforceSourceConfig | ShopifySourceConfig | StripeSourceConfig | SupabaseSourceConfig | VitessSourceConfig | WebhookSourceConfig | ZendeskWebhookSourceConfig
One of:
AlloyDBSourceConfig
transforms.ValueToKey.fields.include.liststring

Move column(s) from value to key. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ValueToKey.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
InsertTopicName.enabledboolean

Add _streamkap_topic field containing the Kafka topic name. Required for topic_router transforms to preserve end-to-end data lineage.

default: false
database.hostname.user.definedstringrequired

PostgreSQL Hostname.

database.port.user.definedstringrequired

PostgreSQL Port. For example, 5432

default: "5432"
database.userstringrequired

Username to access the database

database.passwordstring<password>required

Password to access the database

database.dbnamestringrequired

Database from which to stream data

snapshot.read.only.user.definedstring

When connecting to a read replica PostgreSQL database, this must be set to 'Yes' to support Streamkap snapshots

default: "Yes"
Allowed:YesNo
signal.data.collection.schema.or.databasestringrequired

Full path to the signal table including schema and table name (e.g., 'public.streamkap_signal'). This table is used for incremental snapshotting. Follow the documentation for creating this table.

column.include.list.toggledboolean

Toggle between Inclusion (include only selected columns) and Exclusion (exclude selected columns). Defaults to Inclusion (On).

default: true
column.include.list.user.definedstring

An optional, comma-separated list of regular expressions that match the fully-qualified names of columns that should be included in change event record values. Fully-qualified names for columns are of the form schemaName[.]tableName[.](columnName1|columnName2)

column.exclude.list.user.definedstring

An optional, comma-separated list of regular expressions that match the fully-qualified names of columns that should be excluded from change event record values. Fully-qualified names for columns are of the form schemaName.tableName.columnName.

heartbeat.enabledboolean

When enabled, the connector emits a periodic heartbeat to a Kafka topic — this keeps the poll loop active and offsets advancing on low-traffic sources, preventing replication-slot/log lag and false-positive health alerts. To also write to a 'streamkap_heartbeat' table in the source database (keeps the source transaction log moving), set 'Heartbeat Table Schema' below; leave it blank for Kafka-only mode.

default: true
heartbeat.data.collection.schema.or.databasestring

Optional. The schema containing a 'streamkap_heartbeat' table — providing this enables source-table heartbeat mode, which writes to the table on each beat to keep the source transaction log active. Leave blank for Kafka-only heartbeat (no table or write grant required). See the Streamkap documentation for table setup.

slot.namestringrequired

The name of the replication slot for the connector to use.

default: "streamkap_pgoutput_slot"
publication.namestringrequired

The name of the publication for the connector to use.

default: "streamkap_pub"
schema.include.liststringrequired

Schemas to include.

table.include.list.user.definedstringrequired

Source tables to sync.

reselector.reselect.error.handling.modestring

Controls what happens when the re-select post processor fails to fetch a column. 'Fail' stops the connector; 'Warn' logs a warning and continues.

default: "fail"
Allowed:failwarn
post.processors.reselect.enabledboolean

When enabled, TOAST columns that cannot be read from the WAL are re-fetched from the source database at event time.

default: true
database.sslmodestring

Whether to use an encrypted connection to the PostgreSQL server

default: "require"
Allowed:requiredisable
include.source.db.name.in.table.name.user.definedboolean

Changes the format of topics to 'DatabaseName_TopicName'

default: false
binary.handling.modestring

Specifies how the data for binary columns e.g. blob, binary, varbinary should be represented. This setting depends on what the destination is. See the documentation for more details.

default: "bytes"
Allowed:[object Object][object Object][object Object][object Object]
transforms.InsertStaticKey1.static.fieldstring

The name of the static field to be added to the message key.

transforms.InsertStaticKey1.static.valuestring

The value of the static field to be added to the message key.

transforms.InsertStaticValue1.static.fieldstring

The name of the static field to be added to the message value.

transforms.InsertStaticValue1.static.valuestring

The value of the static field to be added to the message value.

transforms.InsertStaticKey2.static.fieldstring

The name of the static field to be added to the message key.

transforms.InsertStaticKey2.static.valuestring

The value of the static field to be added to the message key.

transforms.InsertStaticValue2.static.fieldstring

The name of the static field to be added to the message value.

transforms.InsertStaticValue2.static.valuestring

The value of the static field to be added to the message value.

predicates.IsTopicToEnrich.patternstring

Regex pattern to match topics for enrichment.

default: "$^"
ssh.enabledboolean

<span>Streamkap will connect to SSH server in your network which has access to your database. This is necessary if Streamkap cannot connect directly to your database. <a href='https://docs.streamkap.com/streamkap-ip-addresses#streamkap-ip-addresses' class='docs-url' target='_blank'>View the Streamkap IP addresses to allowlist on your SSH server</a> </span>

default: false
ssh.hoststringrequired

Hostname of your SSH server

ssh.portstringrequired

Port of your SSH server

default: "22"
ssh.userstringrequired

User that allows Streamkap to connect to SSH server

default: "streamkap"
ssh.public.key.user.displayedstringrequired

Public key to add to SSH server

default: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJVbRrHqNN3SyIYnNF46SMd+ArZz+QheAtjnQzKiBWrc"
Db2SourceConfig
transforms.ValueToKey.fields.include.liststring

Move column(s) from value to key. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ValueToKey.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
InsertTopicName.enabledboolean

Add _streamkap_topic field containing the Kafka topic name. Required for topic_router transforms to preserve end-to-end data lineage.

default: false
database.hostname.user.definedstringrequired

IP address or hostname of the Db2 database server

database.port.user.definedstringrequired

Port number of the Db2 database server

default: "50000"
database.userstringrequired

Name of the Db2 database user for connecting to the DB2 database server

database.passwordstring<password>required

Password to use when connecting to the Db2 database server

database.dbnamestringrequired

The name of the Db2 database from which to stream the changes

schema.include.list.user.definedstringrequired

Source schemas to sync.

table.include.list.user.definedstringrequired

Source tables to sync.

signal.data.collection.schema.or.databasestringrequired

Path to the signal table as schema.table (e.g., 'MYSCHEMA.STREAMKAP_SIGNAL'). The database name will be added automatically. This table is used for incremental snapshotting.

schema.history.internal.store.only.captured.databases.ddlstring

Specifies whether the connector records schema structures from all logical databases in the database instance or only captured databases. Enabling this when you have many databases in your instance can improve performance and avoid timeouts.

default: false
schema.history.internal.store.only.captured.tables.ddlstring

Specifies whether the connector records schema structures from all logical tables in the captured schemas or databases, or only captured tables. Enabling this when you have many tables can improve performance and avoid timeouts.

default: false
ssh.enabledboolean

<span>Streamkap will connect to SSH server in your network which has access to your database. This is necessary if Streamkap cannot connect directly to your database. <a href='https://docs.streamkap.com/streamkap-ip-addresses#streamkap-ip-addresses' class='docs-url' target='_blank'>View the Streamkap IP addresses to allowlist on your SSH server</a> </span>

default: false
ssh.hoststringrequired

Hostname of your SSH server

ssh.portstringrequired

Port of your SSH server

default: "22"
ssh.userstringrequired

User that allows Streamkap to connect to SSH server

default: "streamkap"
column.exclude.list.user.definedstring

An optional, comma-separated list of regular expressions that match the fully-qualified names of columns that should be excluded from change event record values. Fully-qualified names for columns are of the form schemaName.tableName.columnName.

ssh.public.key.user.displayedstringrequired

Public key to add to SSH server

default: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJVbRrHqNN3SyIYnNF46SMd+ArZz+QheAtjnQzKiBWrc"
DocumentDBSourceConfig
transforms.ValueToKey.fields.include.liststring

Move column(s) from value to key. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ValueToKey.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
InsertTopicName.enabledboolean

Add _streamkap_topic field containing the Kafka topic name. Required for topic_router transforms to preserve end-to-end data lineage.

default: false
mongodb.connection.string.user.definedstring<password>required

DocumentDB Connection String. See DocumentDB documentation for further details.

transforms.unwrap.array.encodingstring

How to encode arrays. 'Array' encodes them as Array objects but requires all values in the array to be of the same type. 'Array_String' encodes them as JSON Strings and should be used if arrays have mixed types

default: "array_string"
Allowed:[object Object][object Object]
transforms.unwrap.document.encodingstring

How to encode nested documents. 'Document' encodes them as JSON Objects, 'String' encodes them as JSON Strings

default: "document"
Allowed:[object Object][object Object]
database.include.liststringrequired

Source databases to sync.

collection.include.list.user.definedstringrequired

Source collections to sync.

signal.data.collection.schema.or.databasestringrequired

Full path to the signal collection including database and collection name (e.g., 'mydb.streamkap_signal'). This collection is used for incremental snapshotting. Follow the documentation for creating this collection.

cursor.oversize.handling.modestring

The strategy used to handle change events for documents exceeding specified BSON size.

default: "skip"
Allowed:skipsplit
cursor.oversize.skip.thresholdinteger

The maximum allowed size in bytes of the stored document for which change events are processed. This includes both, the size before and after database operation, more specifically this limits the size of fullDocument and fullDocumentBeforeChange filed of MongoDB change events.

min 1000000 · max 16000000 · default: 16000000
ssh.enabledboolean

<span>Streamkap will connect to SSH server in your network which has access to your database. This is necessary if Streamkap cannot connect directly to your database. <a href='https://docs.streamkap.com/streamkap-ip-addresses#streamkap-ip-addresses' class='docs-url' target='_blank'>View the Streamkap IP addresses to allowlist on your SSH server</a> </span>

default: false
ssh.hoststringrequired

Hostname of your SSH server

ssh.portstringrequired

Port of your SSH server

default: "22"
ssh.userstringrequired

User that allows Streamkap to connect to SSH server

default: "streamkap"
ssh.public.key.user.displayedstringrequired

Public key to add to SSH server

default: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJVbRrHqNN3SyIYnNF46SMd+ArZz+QheAtjnQzKiBWrc"
DynamoDBSourceConfig
incremental.snapshot.chunk.sizeinteger

Number of rows read per snapshot chunk. Lower values throttle snapshot throughput to prevent backlog on the destination

default: "8192"
transforms.ValueToKey.fields.include.liststring

Move column(s) from value to key. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ValueToKey.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
InsertTopicName.enabledboolean

Add _streamkap_topic field containing the Kafka topic name. Required for topic_router transforms to preserve end-to-end data lineage.

default: false
aws.regionstringrequired

AWS Region

aws.access.key.idstring<password>required

AWS Access Key ID

aws.secret.keystring<password>required

AWS Secret Key

s3.export.bucket.namestringrequired

used for backfill (snapshot)

table.include.list.user.definedstringrequired

Source tables to sync.

batch.sizeinteger
dynamodb.service.endpointstring

Dynamodb Service Endpoint (optional)

tasks.maxinteger

The maximum number of active tasks

min 1 · max 40 · default: 10
snapshot.parallel.time.offsetinteger

If > 0, snapshot will run in parallel with streaming and snapshot records _streamkap_ts_ms will be set back in time by this amount to prioritize CDC events downstream

min 0 · max 604800000 · default: 0
poll.timeout.msinteger

Poll Timeout (ms)

default: "180000"
incremental.snapshot.interval.msinteger

Delay in milliseconds between reading snapshot chunks. Higher values throttle snapshot throughput to prevent backlog on the destination

default: "6000"
incremental.snapshot.max.threadsinteger

Incremental snapshot max threads

default: "8"
full.export.expiration.time.msinteger

Full Export Expiration Time (ms)

default: "86400000"
signal.kafka.poll.timeout.msinteger

Signal Kafka Poll Timeout (ms)

default: "1000"
array.encoding.jsonstring

Force nested lists as JSON string

default: true
struct.encoding.jsonstring

Force nested maps as JSON string

default: true
ElasticSearchSourceConfig
transforms.ValueToKey.fields.include.liststring

Move column(s) from value to key. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ValueToKey.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
InsertTopicName.enabledboolean

Add _streamkap_topic field containing the Kafka topic name. Required for topic_router transforms to preserve end-to-end data lineage.

default: false
es.hoststringrequired

ElasticSearch host. Optionally it is possible to specify many hosts using ; as separator (host1;host2;host3)

es.schemestring

ElasticSearch protocol (http/https)

default: "https"
Allowed:httphttps
es.portstringrequired

Port for ElasticSearch HTTP/HTTPS REST API. For example, 443 or 9200

default: 443
http.auth.user.definedstring

Type of Authentication

default: "Basic"
Allowed:NoneBasic
http.auth.userstringrequired

Elasticsearch username

http.auth.passwordstring<password>required

Elasticsearch password

endpoint.include.list.user.definedstringrequired

The name of ElasticSearch indices

datetime.field.namestringrequired

The name of datetime field to use to detect new records.

datetime.field.valuestring

The day and time to start consuming records from. Leave it empty if you want to consume records as of now.

tasks.maxinteger

The maximum number of active tasks

min 1 · max 10 · default: 5
InformixSourceConfig
transforms.ValueToKey.fields.include.liststring

Move column(s) from value to key. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ValueToKey.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
InsertTopicName.enabledboolean

Add _streamkap_topic field containing the Kafka topic name. Required for topic_router transforms to preserve end-to-end data lineage.

default: false
database.hostname.user.definedstringrequired

IP address or hostname of the Informix database server.

database.port.user.definedstringrequired

Informix SQLI listener port. For example, 9088.

default: "9088"
database.userstringrequired

Username to access the Informix database.

database.passwordstring<password>required

Password to access the Informix database.

database.dbnamestringrequired

The name of the Informix database from which to stream the changes.

schema.include.liststringrequired

Schemas to include.

table.include.list.user.definedstringrequired

Source tables to sync.

signal.data.collection.schema.or.databasestringrequired

Path to the signal table as schema.table (e.g., 'myschema.streamkap_signal'). The database name will be added automatically. This table is used for incremental snapshotting.

default: "streamkap"
column.exclude.list.user.definedstring

An optional, comma-separated list of regular expressions that match the fully-qualified names of columns that should be excluded from change event record values. Fully-qualified names for columns are of the form schemaName.tableName.columnName.

heartbeat.enabledboolean

When enabled, the connector emits a periodic heartbeat to a Kafka topic — this keeps the poll loop active and offsets advancing on low-traffic sources, preventing replication-log lag and false-positive health alerts. To also write to a 'streamkap_heartbeat' table in the source database (keeps the source transaction log moving), set 'Heartbeat Table Schema' below; leave it blank for Kafka-only mode.

default: true
heartbeat.data.collection.schema.or.databasestring

Optional. The schema containing a 'streamkap_heartbeat' table — providing this enables source-table heartbeat mode, which writes to the table on each beat to keep the source transaction log active. Leave blank for Kafka-only heartbeat (no table or write grant required). See the Streamkap documentation for table setup.

schema.history.internal.store.only.captured.databases.ddlstring

Specifies whether the connector records schema structures from all logical databases in the database instance or only captured databases. Enabling this when you have many databases in your instance can improve performance and avoid timeouts.

default: false
schema.history.internal.store.only.captured.tables.ddlstring

Specifies whether the connector records schema structures from all logical tables in the captured schemas or databases, or only captured tables. Enabling this when you have many tables can improve performance and avoid timeouts.

default: false
binary.handling.modestring

Specifies how the data for binary columns e.g. blob, byte, text should be represented. This setting depends on what the destination is. See the documentation for more details.

default: "bytes"
Allowed:[object Object][object Object][object Object][object Object]
cdc.buffersizeinteger

Size of the read buffer for receiving CDC events from the Informix server, in bytes.

min 4096 · max 1048576 · default: 65536
cdc.timeoutinteger

Timeout (seconds) the CDC engine will wait before breaking out of a blocking read to check for shutdown signals.

min 1 · max 60 · default: 5
streamkap.snapshot.parallelisminteger

How many parallel chunk requests to send to the source DB.

min 1 · max 50 · default: 1
streamkap.snapshot.chunk.size.bytesinteger

Target byte size for one chunk SELECT. Drives LIMIT = ceil(chunk.size.bytes / avg_row_size).

min 4096 · max 8388608 · default: 524288
streamkap.snapshot.state.refresh.msinteger

Executor publish cadence (ms) — how often the parallel-snapshot executor publishes SourceSnapshotState (rows_scanned, status transitions) to the streamkap_state topic. Lower values surface progress faster at the cost of state-topic traffic.

min 1000 · max 60000 · default: 30000
ssh.enabledboolean

<span>Streamkap will connect to SSH server in your network which has access to your database. This is necessary if Streamkap cannot connect directly to your database. <a href='https://docs.streamkap.com/streamkap-ip-addresses#streamkap-ip-addresses' class='docs-url' target='_blank'>View the Streamkap IP addresses to allowlist on your SSH server</a> </span>

default: false
ssh.hoststringrequired

Hostname of your SSH server

ssh.portstringrequired

Port of your SSH server

default: "22"
ssh.userstringrequired

User that allows Streamkap to connect to SSH server

default: "streamkap"
transforms.InsertStaticKey1.static.fieldstring

The name of the static field to be added to the message key.

transforms.InsertStaticKey1.static.valuestring

The value of the static field to be added to the message key.

transforms.InsertStaticValue1.static.fieldstring

The name of the static field to be added to the message value.

transforms.InsertStaticValue1.static.valuestring

The value of the static field to be added to the message value.

ssh.public.key.user.displayedstringrequired

Public key to add to SSH server

default: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJVbRrHqNN3SyIYnNF46SMd+ArZz+QheAtjnQzKiBWrc"
KafkaDirectSourceConfig
topic.prefixstringrequired

Prefix for the topic

topic.include.list.user.definedstringrequired

Comma-separated topic names to stream from this Kafka cluster.

formatstring

The serialised format of the data written to the Kafka topic

default: "string"
Allowed:jsonstringavro
schemas.enableboolean

If untoggled (default), Streamkap attempts to infer schema from your data - depending on the Destination. Otherwise, Streamkap assumes the Kafka message key and value contain schema and payload structures

default: false
records.carry.streamkap.metadataboolean

Enable when this topic is fed by another Streamkap pipeline and records already carry _streamkap_offset, _streamkap_ts_ms, _streamkap_source_ts_ms. Skips destination-side InsertField so upstream offsets are preserved.

default: false
MariaDBSourceConfig
transforms.ValueToKey.fields.include.liststring

Move column(s) from value to key. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ValueToKey.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
InsertTopicName.enabledboolean

Add _streamkap_topic field containing the Kafka topic name. Required for topic_router transforms to preserve end-to-end data lineage.

default: false
database.hostname.user.definedstringrequired

The IP address or hostname of the MariaDB database server. For example, mariadb.something.rds.amazonaws.com

database.port.user.definedstringrequired

Port number of the MariaDB database server. For example, 3306

default: "3306"
database.userstringrequired

The name of the MariaDB user that the connector uses to connect to the MariaDB database server.

database.passwordstring<password>required

The password of the MariaDB user that the connector uses to connect to the MariaDB database server.

database.include.list.user.definedstringrequired

Databases to include. The connector does not capture changes in any database whose name is not included.

table.include.list.user.definedstringrequired

Source tables to sync. The connector does not capture changes in any table that is not included.

signal.data.collection.schema.or.databasestringrequired

Full path to the signal table including database and table name (e.g., 'mydb.streamkap_signal'). This table is used for incremental snapshotting. Follow the documentation for creating this table.

heartbeat.enabledboolean

When enabled, the connector emits a periodic heartbeat to a Kafka topic — this keeps the poll loop active and offsets advancing on low-traffic sources, preventing replication-slot/log lag and false-positive health alerts. To also write to a 'streamkap_heartbeat' table in the source database (keeps the source transaction log moving), set 'Heartbeat Table Database' below; leave it blank for Kafka-only mode.

default: true
heartbeat.data.collection.schema.or.databasestring

Optional. The database containing a 'streamkap_heartbeat' table — providing this enables source-table heartbeat mode, which writes to the table on each beat to keep the source transaction log active. Leave blank for Kafka-only heartbeat (no table or write grant required). See the Streamkap documentation for table setup.

database.connectionTimeZonestring

Set the connection timezone. If set to SERVER, the source will detect the connection time zone from the values configured on the MariaDB server session variables 'time_zone' or 'system_time_zone'

default: "SERVER"
Allowed:SERVERUTCAfrica/Cairo Asia/RiyadhAfrica/CasablancaAsia/SeoulAfrica/HarareAsia/ShanghaiAfrica/MonroviaAsia/SingaporeAfrica/NairobiAsia/TaipeiAfrica/TripoliAsia/TehranAfrica/WindhoekAsia/TokyoAmerica/AraguainaAsia/UlaanbaatarAmerica/AsuncionAsia/VladivostokAmerica/BogotaAsia/YakutskAmerica/Buenos_AiresAsia/YerevanAmerica/CaracasAtlantic/AzoresAmerica/ChihuahuaAustralia/AdelaideAmerica/CuiabaAustralia/BrisbaneAmerica/DenverAustralia/DarwinAmerica/FortalezaAustralia/HobartAmerica/GuatemalaAustralia/PerthAmerica/HalifaxAustralia/SydneyAmerica/ManausBrazil/EastAmerica/MatamorosCanada/NewfoundlandAmerica/MonterreyCanada/SaskatchewanAmerica/MontevideoCanada/YukonAmerica/PhoenixEurope/AmsterdamAmerica/SantiagoEurope/AthensAmerica/TijuanaEurope/DublinAsia/AmmanEurope/HelsinkiAsia/AshgabatEurope/IstanbulAsia/BaghdadEurope/KaliningradAsia/BakuEurope/MoscowAsia/BangkokEurope/ParisAsia/BeirutEurope/PragueAsia/CalcuttaEurope/SarajevoAsia/DamascusPacific/AucklandAsia/DhakaPacific/FijiAsia/IrkutskPacific/GuamAsia/JerusalemPacific/HonoluluAsia/KabulPacific/SamoaAsia/KarachiUS/AlaskaAsia/KathmanduUS/CentralAsia/KrasnoyarskUS/EasternAsia/MagadanUS/East-IndianaAsia/MuscatUS/PacificAsia/Novosibirsk
inconsistent.schema.handling.mode.user.definedstring

How to handle a change event for a table whose schema is unknown or unreadable (for example a regex-matched database the connector lacks privileges on). 'Automatic' uses Warn when regex support is enabled (skip the event and keep streaming) and Fail otherwise.

default: "Automatic"
Allowed:AutomaticFailWarnSkip
snapshot.gtidstring

Whether or not to use a read-only connection. MariaDB has GTID enabled by default, so no additional configuration is necessary.

default: "Yes"
Allowed:YesNo
SourceRegexSupport.enabledboolean

Enable regex support. Useful for merging multiple tables into the same output topic.

default: false
transforms.SourceRegexSupport.regex.replacementstring

Replacement string for matching regex snippets.

default: "REGEX"
transforms.SourceRegexSupport.key.field.templatestring

Regex support key field template. An extra key field is needed to ensure unique data across all tables. Use this template with available variables: database, schema, table, sourceId

default: "{{database}}.{{table}}"
schema.history.internal.store.only.captured.databases.ddlstring

Specifies whether the connector records schema structures from all logical databases in the database instance or only captured databases. Enabling this when you have many databases in your instance can improve performance and avoid timeouts.

default: false
transforms.SourceRegexSupport.metadata.field.namestring

Name of the extra metadata field to store source information and ensure uniqueness across all tables when regex support is enabled.

default: "_streamkap_source_metadata"
schema.history.internal.store.only.captured.tables.ddlstring

Specifies whether the connector records schema structures from all logical tables in the captured schemas or databases, or only captured tables. Enabling this when you have many tables can improve performance and avoid timeouts.

default: false
binary.handling.modestring

Specifies how the data for binary columns e.g. blob, binary, varbinary should be represented. This setting depends on what the destination is. See the documentation for more details.

default: "bytes"
Allowed:[object Object][object Object][object Object][object Object]
database.ssl.modestring

Enables SSL/TLS in a specific mode. 'disable' = unencrypted connection. 'trust' = encrypted, no certificate verification.

default: "trust"
Allowed:disabletrust
ssh.enabledboolean

<span>Streamkap will connect to SSH server in your network which has access to your database. This is necessary if Streamkap cannot connect directly to your database. <a href='https://docs.streamkap.com/streamkap-ip-addresses#streamkap-ip-addresses' class='docs-url' target='_blank'>View the Streamkap IP addresses to allowlist on your SSH server</a> </span>

default: false
ssh.hoststringrequired

Hostname of your SSH server

ssh.portstringrequired

Port of your SSH server

default: "22"
ssh.userstringrequired

User that allows Streamkap to connect to SSH server

default: "streamkap"
column.exclude.list.user.definedstring

An optional, comma-separated list of regular expressions that match the fully-qualified names of columns that should be excluded from change event record values. Fully-qualified names for columns are of the form schemaName.tableName.columnName.

ssh.public.key.user.displayedstringrequired

Public key to add to SSH server

default: "<SSH.PUBLIC.KEY>"
streamkap.snapshot.parallelisminteger

How many parallel chunk requests to send to the source DB.

min 1 · max 50 · default: 1
streamkap.snapshot.chunk.size.bytesinteger

Target byte size for one chunk SELECT. Drives LIMIT = ceil(chunk.size.bytes / avg_row_size).

min 4096 · max 8388608 · default: 524288
streamkap.snapshot.max.split.size.bytesinteger

A table with an estimated size greater than max split size will trigger intra-table paralelism. Table will be split into max.split.size.bytes parts and the parts will be processed in parallel.

min 10485760 · max 214748364800 · default: 53687091200
streamkap.snapshot.state.refresh.msinteger

Snapshot progress publish candence, publishing more often can affect performance.

min 1000 · max 60000 · default: 30000
MongoDBSourceConfig
transforms.ValueToKey.fields.include.liststring

Move column(s) from value to key. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ValueToKey.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
InsertTopicName.enabledboolean

Add _streamkap_topic field containing the Kafka topic name. Required for topic_router transforms to preserve end-to-end data lineage.

default: false
mongodb.connection.string.user.definedstring<password>required

Mongodb Connection String. See Mongodb documentation for further details.

mongodb.connection.hostnamestring

The hostname(s) extracted from the MongoDB connection string.

default: ""
transforms.unwrap.array.encodingstring

How to encode arrays. 'Array' encodes them as Array objects but requires all values in the array to be of the same type. 'Array_String' encodes them as JSON Strings and should be used if arrays have mixed types. 'String' is deprecated, use 'Array_String' instead

default: "array_string"
Allowed:[object Object][object Object][object Object]
transforms.unwrap.document.encodingstring

How to encode nested documents. 'Document' encodes them as JSON Objects, 'String' encodes them as JSON Strings

default: "document"
Allowed:[object Object][object Object]
database.include.liststringrequired

Source databases to sync.

collection.include.list.user.definedstringrequired

Source collections to sync.

signal.data.collection.schema.or.databasestringrequired

Full path to the signal collection including database and collection name (e.g., 'mydb.streamkap_signal'). This collection is used for incremental snapshotting. Follow the documentation for creating this collection.

cursor.pipelinestring

A JSON array of additional pipeline stages to apply when reading change events from MongoDB. This can be used to filter or transform change stream events before they are processed by the connector

cursor.oversize.handling.modestring

The strategy used to handle change events for documents exceeding specified BSON size. 'Skip' ignores oversized documents, 'Split' breaks them into smaller chunks

default: "skip"
Allowed:skipsplit
cursor.oversize.skip.thresholdinteger

The maximum allowed size in bytes of the stored document for which change events are processed. This includes both the size before and after the database operation, specifically this limits the size of fullDocument and fullDocumentBeforeChange fields of MongoDB change events

min 1000000 · max 16000000 · default: 16000000
transforms.InsertStaticKey1.static.fieldstring

The name of the static field to be added to the message key.

transforms.InsertStaticKey1.static.valuestring

The value of the static field to be added to the message key.

transforms.InsertStaticValue1.static.fieldstring

The name of the static field to be added to the message value.

transforms.InsertStaticValue1.static.valuestring

The value of the static field to be added to the message value.

transforms.InsertStaticKey2.static.fieldstring

The name of the static field to be added to the message key.

transforms.InsertStaticKey2.static.valuestring

The value of the static field to be added to the message key.

transforms.InsertStaticValue2.static.fieldstring

The name of the static field to be added to the message value.

transforms.InsertStaticValue2.static.valuestring

The value of the static field to be added to the message value.

predicates.IsTopicToEnrich.patternstring

Regex pattern to match topics for enrichment.

default: "$^"
ssh.enabledboolean

<span>Streamkap will connect to SSH server in your network which has access to your database. This is necessary if Streamkap cannot connect directly to your database. <a href='https://docs.streamkap.com/streamkap-ip-addresses#streamkap-ip-addresses' class='docs-url' target='_blank'>View the Streamkap IP addresses to allowlist on your SSH server</a> </span>

default: false
ssh.hoststringrequired

Hostname of your SSH server

ssh.portstringrequired

Port of your SSH server

default: "22"
ssh.userstringrequired

User that allows Streamkap to connect to SSH server

default: "streamkap"
ssh.public.key.user.displayedstringrequired

Public key to add to SSH server

default: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJVbRrHqNN3SyIYnNF46SMd+ArZz+QheAtjnQzKiBWrc"
MySQLSourceConfig
transforms.ValueToKey.fields.include.liststring

Move column(s) from value to key. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ValueToKey.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
InsertTopicName.enabledboolean

Add _streamkap_topic field containing the Kafka topic name. Required for topic_router transforms to preserve end-to-end data lineage.

default: false
database.hostname.user.definedstringrequired

MySQL Hostname. For example, mysqldb.something.rds.amazonaws.com

database.port.user.definedstringrequired

MySQL Port. For example, 3306

default: "3306"
database.userstringrequired

Username to access the database

database.passwordstring<password>required

Password to access the database

database.include.list.user.definedstringrequired

Databases to include.

table.include.list.user.definedstringrequired

Source tables to sync.

signal.data.collection.schema.or.databasestringrequired

Full path to the signal table including database and table name (e.g., 'mydb.streamkap_signal'). This table is used for incremental snapshotting. Follow the documentation for creating this table.

column.include.list.toggledboolean

Toggle between Inclusion (include only selected columns) and Exclusion (exclude selected columns). Defaults to Inclusion (On).

default: true
column.include.list.user.definedstring

An optional, comma-separated list of regular expressions that match the fully-qualified names of columns that should be included in change event record values. Fully-qualified names for columns are of the form schemaName[.]tableName[.](columnName1|columnName2)

column.exclude.list.user.definedstring

An optional, comma-separated list of regular expressions that match the fully-qualified names of columns that should be excluded from change event record values. Fully-qualified names for columns are of the form schemaName.tableName.columnName.

heartbeat.enabledboolean

When enabled, the connector emits a periodic heartbeat to a Kafka topic — this keeps the poll loop active and offsets advancing on low-traffic sources, preventing replication-slot/log lag and false-positive health alerts. To also write to a 'streamkap_heartbeat' table in the source database (keeps the source transaction log moving), set 'Heartbeat Table Database' below; leave it blank for Kafka-only mode.

default: true
heartbeat.data.collection.schema.or.databasestring

Optional. The database containing a 'streamkap_heartbeat' table — providing this enables source-table heartbeat mode, which writes to the table on each beat to keep the source transaction log active. Leave blank for Kafka-only heartbeat (no table or write grant required). See the Streamkap documentation for table setup.

database.connectionTimeZonestring

Set the connection timezone. If set to SERVER, the source will detect the connection time zone from the values configured on the MySQL server session variables 'time_zone' or 'system_time_zone'

default: "SERVER"
Allowed:SERVERUTCAfrica/Cairo Asia/RiyadhAfrica/CasablancaAsia/SeoulAfrica/HarareAsia/ShanghaiAfrica/MonroviaAsia/SingaporeAfrica/NairobiAsia/TaipeiAfrica/TripoliAsia/TehranAfrica/WindhoekAsia/TokyoAmerica/AraguainaAsia/UlaanbaatarAmerica/AsuncionAsia/VladivostokAmerica/BogotaAsia/YakutskAmerica/Buenos_AiresAsia/YerevanAmerica/CaracasAtlantic/AzoresAmerica/ChihuahuaAustralia/AdelaideAmerica/CuiabaAustralia/BrisbaneAmerica/DenverAustralia/DarwinAmerica/FortalezaAustralia/HobartAmerica/GuatemalaAustralia/PerthAmerica/HalifaxAustralia/SydneyAmerica/ManausBrazil/EastAmerica/MatamorosCanada/NewfoundlandAmerica/MonterreyCanada/SaskatchewanAmerica/MontevideoCanada/YukonAmerica/PhoenixEurope/AmsterdamAmerica/SantiagoEurope/AthensAmerica/TijuanaEurope/DublinAsia/AmmanEurope/HelsinkiAsia/AshgabatEurope/IstanbulAsia/BaghdadEurope/KaliningradAsia/BakuEurope/MoscowAsia/BangkokEurope/ParisAsia/BeirutEurope/PragueAsia/CalcuttaEurope/SarajevoAsia/DamascusPacific/AucklandAsia/DhakaPacific/FijiAsia/IrkutskPacific/GuamAsia/JerusalemPacific/HonoluluAsia/KabulPacific/SamoaAsia/KarachiUS/AlaskaAsia/KathmanduUS/CentralAsia/KrasnoyarskUS/EasternAsia/MagadanUS/East-IndianaAsia/MuscatUS/PacificAsia/Novosibirsk
inconsistent.schema.handling.mode.user.definedstring

How to handle a change event for a table whose schema is unknown or unreadable (for example a regex-matched database the connector lacks privileges on). 'Automatic' uses Warn when regex support is enabled (skip the event and keep streaming) and Fail otherwise.

default: "Automatic"
Allowed:AutomaticFailWarnSkip
snapshot.gtidstring

Whether or not to use a read-only connection. Requires GTID mode to be enabled on the source database.

default: "Yes"
Allowed:YesNo
SourceRegexSupport.enabledboolean

Enable regex support. Useful for merging multiple tables into the same output topic.

default: false
transforms.SourceRegexSupport.regex.replacementstring

Replacement string for matching regex snippets.

default: "_REGEX_"
transforms.SourceRegexSupport.key.field.templatestring

Regex support key field template. An extra key field is needed to ensure unique data across all tables. Use this template with available variables: database, schema, table, sourceId

default: "{{database}}.{{table}}"
transforms.SourceRegexSupport.metadata.field.namestring

Name of the extra metadata field to store source information and ensure uniqueness across all tables when regex support is enabled.

default: "_streamkap_source_metadata"
schema.history.internal.store.only.captured.databases.ddlstring

Specifies whether the connector records schema structures from all logical databases in the database instance or only captured databases. Enabling this when you have many databases in your instance can improve performance and avoid timeouts.

default: false
schema.history.internal.store.only.captured.tables.ddlstring

Specifies whether the connector records schema structures from all logical tables in the captured schemas or databases, or only captured tables. Enabling this when you have many tables can improve performance and avoid timeouts.

default: false
binary.handling.modestring

Specifies how the data for binary columns e.g. blob, binary, varbinary should be represented. This setting depends on what the destination is. See the documentation for more details.

default: "bytes"
Allowed:[object Object][object Object][object Object][object Object]
ssh.enabledboolean

<span>Streamkap will connect to SSH server in your network which has access to your database. This is necessary if Streamkap cannot connect directly to your database. <a href='https://docs.streamkap.com/streamkap-ip-addresses#streamkap-ip-addresses' class='docs-url' target='_blank'>View the Streamkap IP addresses to allowlist on your SSH server</a> </span>

default: false
ssh.hoststringrequired

Hostname of your SSH server

ssh.portstringrequired

Port of your SSH server

default: "22"
ssh.userstringrequired

User that allows Streamkap to connect to SSH server

default: "streamkap"
transforms.InsertStaticKey1.static.fieldstring

The name of the static field to be added to the message key.

transforms.InsertStaticKey1.static.valuestring

The value of the static field to be added to the message key.

transforms.InsertStaticValue1.static.fieldstring

The name of the static field to be added to the message value.

transforms.InsertStaticValue1.static.valuestring

The value of the static field to be added to the message value.

transforms.InsertStaticKey2.static.fieldstring

The name of the static field to be added to the message key.

transforms.InsertStaticKey2.static.valuestring

The value of the static field to be added to the message key.

transforms.InsertStaticValue2.static.fieldstring

The name of the static field to be added to the message value.

transforms.InsertStaticValue2.static.valuestring

The value of the static field to be added to the message value.

predicates.IsTopicToEnrich.patternstring

Regex pattern to match topics for enrichment.

default: "$^"
ssh.public.key.user.displayedstringrequired

Public key to add to SSH server

default: "<SSH.PUBLIC.KEY>"
streamkap.snapshot.parallelisminteger

How many parallel chunk requests to send to the source DB.

min 1 · max 50 · default: 1
streamkap.snapshot.chunk.size.bytesinteger

Target byte size for one chunk SELECT. Drives LIMIT = ceil(chunk.size.bytes / avg_row_size).

min 4096 · max 8388608 · default: 524288
streamkap.snapshot.max.split.size.bytesinteger

A table with an estimated size greater than max split size will trigger intra-table paralelism. Table will be split into max.split.size.bytes parts and the parts will be processed in parallel.

min 10485760 · max 214748364800 · default: 53687091200
streamkap.snapshot.state.refresh.msinteger

Snapshot progress publish candence, publishing more often can affect performance.

min 1000 · max 60000 · default: 30000
OracleSourceConfig
transforms.ValueToKey.fields.include.liststring

Move column(s) from value to key. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ValueToKey.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
InsertTopicName.enabledboolean

Add _streamkap_topic field containing the Kafka topic name. Required for topic_router transforms to preserve end-to-end data lineage.

default: false
database.hostname.user.definedstringrequired

Oracle Hostname Or IP address

database.port.user.definedstringrequired

Oracle Port. For example, 1521

default: "1521"
database.userstringrequired

Username to access the database

database.passwordstring<password>required

Password to access the database

database.dbnamestringrequired

Database from which to stream data. If you're working with container databases (CDB), this should be the CDB name.

database.pdb.namestring

Pluggable database from which to stream data. Use this for container database (CDB) installations only.

schema.include.liststringrequired

Schemas to include.

table.include.list.user.definedstringrequired

Source tables to sync.

signal.data.collection.schema.or.databasestringrequired

Full path to the signal table including schema and table name (e.g., 'MYSCHEMA.STREAMKAP_SIGNAL'). This table is used for incremental snapshotting. Follow the documentation for creating this table.

heartbeat.enabledboolean

When enabled, the connector emits a periodic heartbeat to a Kafka topic - this keeps the poll loop active and offsets advancing on low-traffic sources, preventing replication-slot/log lag and false-positive health alerts. To also write to a 'streamkap_heartbeat' table in the source database (keeps the source transaction log moving), set 'Heartbeat Table Schema' below; leave it blank for Kafka-only mode.

default: true
heartbeat.data.collection.schema.or.databasestring

Optional. The schema containing a 'streamkap_heartbeat' table - providing this enables source-table heartbeat mode, which writes to the table on each beat to keep the source transaction log active. Leave blank for Kafka-only heartbeat (no table or write grant required). See the Streamkap documentation for table setup.

schema.history.internal.store.only.captured.databases.ddlstring

Specifies whether the connector records schema structures from all logical databases in the database instance or only captured databases. Enabling this when you have many databases in your instance can improve performance and avoid timeouts.

default: false
schema.history.internal.store.only.captured.tables.ddlstring

Specifies whether the connector records schema structures from all logical tables in the captured schemas or databases, or only captured tables. Enabling this when you have many tables can improve performance and avoid timeouts.

default: false
binary.handling.modestring

Specifies how the data for binary columns e.g. blob, binary, varbinary should be represented. This setting depends on what the destination is. See the documentation for more details.

default: "bytes"
Allowed:[object Object][object Object][object Object][object Object]
ssh.enabledboolean

<span>Streamkap will connect to SSH server in your network which has access to your database. This is necessary if Streamkap cannot connect directly to your database. <a href='https://docs.streamkap.com/streamkap-ip-addresses#streamkap-ip-addresses' class='docs-url' target='_blank'>View the Streamkap IP addresses to allowlist on your SSH server</a> </span>

default: false
ssh.hoststringrequired

Hostname of your SSH server

ssh.portstringrequired

Port of your SSH server

default: "22"
ssh.userstringrequired

User that allows Streamkap to connect to SSH server

default: "streamkap"
column.exclude.list.user.definedstring

An optional, comma-separated list of regular expressions that match the fully-qualified names of columns that should be excluded from change event record values. Fully-qualified names for columns are of the form schemaName.tableName.columnName.

log.mining.strategystring

Controls how LogMiner resolves column metadata. 'online_catalog' (default) is fastest; 'redo_log_catalog' mines the data dictionary from redo logs and handles schema changes better; 'hybrid' combines both but has limitations with certain settings (e.g. LOB capture is not supported).

default: "online_catalog"
Allowed:[object Object][object Object][object Object]
lob.enabledboolean

Enables capture of CLOB, NCLOB, and BLOB columns. Not supported with the Hybrid strategy. When combined with the Re-select Post Processor, LOB values unavailable in the redo log are re-fetched from the source at event time, producing one merged event per row change.

default: false
post.processors.reselect.enabledboolean

When enabled, columns unavailable in the redo log (e.g. LOB columns) are re-fetched from the source database at event time. For LOB capture, enable together with 'Redo Log Catalog' strategy and 'Enable LOB Column Capture'.

default: false
reselector.reselect.error.handling.modestring

Controls what happens when the re-select post processor fails to fetch a column. 'Fail' stops the connector; 'Warn' logs a warning and continues.

default: "fail"
Allowed:failwarn
ssh.public.key.user.displayedstringrequired

Public key to add to SSH server

default: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJVbRrHqNN3SyIYnNF46SMd+ArZz+QheAtjnQzKiBWrc"
PlanetscaleVitessSourceConfig
transforms.ValueToKey.fields.include.liststring

Move column(s) from value to key. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ValueToKey.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
InsertTopicName.enabledboolean

Add _streamkap_topic field containing the Kafka topic name. Required for topic_router transforms to preserve end-to-end data lineage.

default: false
database.hostname.user.definedstringrequired

IP address or hostname of the PlanetScale database server (VTGate).

database.port.user.definedstringrequired

Integer port number of the PlanetScale database server (VTGate).

default: "443"
database.userstringrequired

Username of the PlanetScale database server (VTGate).

database.passwordstring<password>required

Password of the PlanetScale database server (VTGate).

vitess.keyspacestringrequired

The name of the keyspace from which to stream the changes.

vitess.tablet.typestring

The type of Tablet (hence MySQL) from which to stream the changes

default: "MASTER"
Allowed:MASTERREPLICARDONLY
converter.tinyintBool.user.definedstring

Convert tinyInt(1) columns to boolean

default: false
table.include.list.user.definedstringrequired

Source tables to sync.

schema.history.internal.store.only.captured.databases.ddlstring

Specifies whether the connector records schema structures from all logical databases in the database instance or only captured databases. Enabling this when you have many databases in your instance can improve performance and avoid timeouts.

default: false
schema.history.internal.store.only.captured.tables.ddlstring

Specifies whether the connector records schema structures from all logical tables in the captured schemas or databases, or only captured tables. Enabling this when you have many tables can improve performance and avoid timeouts.

default: false
database.ssl.disabledstring

Disable TLS on the VTGate gRPC connection and use plaintext. Leave off for PlanetScale Cloud (TLS required); enable only for a local / self-hosted plaintext Vitess.

default: false
vitess.set.basic.authentication.headerstring

Send an HTTP-style authorization: Basic header on VTGate gRPC calls. Keep on for PlanetScale Cloud (its gateway requires it); turn off for a self-hosted vtgate started with --grpc_auth_mode static, which instead expects vitess-native StaticAuthCredentials.

default: true
ssh.enabledboolean

<span>Streamkap will connect to SSH server in your network which has access to your database. This is necessary if Streamkap cannot connect directly to your database. <a href='https://docs.streamkap.com/streamkap-ip-addresses#streamkap-ip-addresses' class='docs-url' target='_blank'>View the Streamkap IP addresses to allowlist on your SSH server</a> </span>

default: false
ssh.hoststringrequired

Hostname of your SSH server

ssh.portstringrequired

Port of your SSH server

default: "22"
ssh.userstringrequired

User that allows Streamkap to connect to SSH server

default: "streamkap"
column.exclude.list.user.definedstring

An optional, comma-separated list of regular expressions that match the fully-qualified names of columns that should be excluded from change event record values. Fully-qualified names for columns are of the form schemaName.tableName.columnName.

ssh.public.key.user.displayedstringrequired

Public key to add to SSH server

default: "<SSH.PUBLIC.KEY>"
streamkap.snapshot.parallelisminteger

How many parallel chunk requests to send to the source DB.

min 1 · max 50 · default: 1
streamkap.snapshot.chunk.size.bytesinteger

Target byte size for one chunk SELECT. Drives LIMIT = ceil(chunk.size.bytes / avg_row_size).

min 4096 · max 8388608 · default: 524288
streamkap.snapshot.max.split.size.bytesinteger

A table with an estimated size greater than max split size will trigger intra-table paralelism. Table will be split into max.split.size.bytes parts and the parts will be processed in parallel.

min 10485760 · max 214748364800 · default: 53687091200
streamkap.snapshot.state.refresh.msinteger

Snapshot progress publish candence, publishing more often can affect performance.

min 1000 · max 60000 · default: 30000
vtgate.mysql.portstring

Port of the VTGate MySQL wire-protocol endpoint used for parallel-snapshot chunk reads (the gRPC vstream endpoint is database.port). PlanetScale Cloud = 3306; self-hosted vtgate typically 15306.

default: "3306"
PostgreSQLSourceConfig
transforms.ValueToKey.fields.include.liststring

Move column(s) from value to key. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ValueToKey.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
InsertTopicName.enabledboolean

Add _streamkap_topic field containing the Kafka topic name. Required for topic_router transforms to preserve end-to-end data lineage.

default: false
database.hostname.user.definedstringrequired

PostgreSQL Hostname. For example, postgres.something.rds.amazonaws.com

database.port.user.definedstringrequired

PostgreSQL Port. For example, 5432

default: "5432"
database.userstringrequired

Username to access the database

database.passwordstring<password>required

Password to access the database

database.dbnamestringrequired

Database from which to stream data

snapshot.read.only.user.definedstring

When connecting to a read replica PostgreSQL database, this must be set to 'Yes' to support Streamkap snapshots

default: "Yes"
Allowed:YesNo
signal.data.collection.schema.or.databasestringrequired

Full path to the signal table including schema and table name (e.g., 'public.streamkap_signal'). This table is used for incremental snapshotting. Follow the documentation for creating this table.

column.include.list.toggledboolean

Toggle between Inclusion (include only selected columns) and Exclusion (exclude selected columns). Defaults to Inclusion (On).

default: true
SourceRegexSupport.enabledboolean

Enable regex support. Useful for merging multiple tables into the same output topic

default: false
transforms.SourceRegexSupport.regex.replacementstring

Replacement string for matching regex snippets.

default: "_REGEX_"
transforms.SourceRegexSupport.key.field.templatestring

Regex support key field template. An extra key field is needed to ensure unique data across all tables. Use this template with available variables: database, schema, table, sourceId

default: "{{database}}.{{table}}"
transforms.SourceRegexSupport.metadata.field.namestring

Name of the extra metadata field to store source information and ensure uniqueness across all tables when regex support is enabled.

default: "_streamkap_source_metadata"
column.include.list.user.definedstring

An optional, comma-separated list of regular expressions that match the fully-qualified names of columns that should be included in change event record values. Fully-qualified names for columns are of the form schemaName[.]tableName[.](columnName1|columnName2)

column.exclude.list.user.definedstring

An optional, comma-separated list of regular expressions that match the fully-qualified names of columns that should be excluded from change event record values. Fully-qualified names for columns are of the form schemaName.tableName.columnName.

heartbeat.enabledboolean

When enabled, the connector emits a periodic heartbeat to a Kafka topic - this keeps the poll loop active and offsets advancing on low-traffic sources, preventing replication-slot/log lag and false-positive health alerts. To also write to a 'streamkap_heartbeat' table in the source database (keeps the source transaction log moving), set 'Heartbeat Table Schema' below; leave it blank for Kafka-only mode.

default: true
heartbeat.data.collection.schema.or.databasestring

Optional. The schema containing a 'streamkap_heartbeat' table - providing this enables source-table heartbeat mode, which writes to the table on each beat to keep the source transaction log active. Leave blank for Kafka-only heartbeat (no table or write grant required). See the Streamkap documentation for table setup.

heartbeat.use.logical.messageboolean

Use a logical-message heartbeat instead of a heartbeat table. Runs SELECT pg_logical_emit_message(true, ...) on each beat to keep the replication slot advancing - works on PG14+ primaries with a SELECT-only role and is compatible with read-only mode. No table or write grant required on the source.

default: false
slot.namestringrequired

The name of the replication slot for the connector to use.

default: "streamkap_pgoutput_slot"
publication.namestringrequired

The name of the publication for the connector to use.

default: "streamkap_pub"
schema.include.liststringrequired

Comma-separated schemas to capture from this database. Tables inside the listed schemas can be picked individually on the next step.

table.include.list.user.definedstringrequired

Source tables to sync.

post.processors.reselect.enabledboolean

When enabled, TOAST columns that cannot be read from the WAL are re-fetched from the source database at event time.

default: true
reselector.reselect.error.handling.modestring

Controls what happens when the re-select post processor fails to fetch a column. 'Fail' stops the connector; 'Warn' logs a warning and continues.

default: "fail"
Allowed:failwarn
database.sslmodestring

Whether to use an encrypted connection to the PostgreSQL server

default: "require"
Allowed:requiredisable
include.source.db.name.in.table.name.user.definedboolean

Changes the format of topics to 'DatabaseName_TopicName'

default: false
binary.handling.modestring

Specifies how the data for binary columns e.g. blob, binary, varbinary should be represented. This setting depends on what the destination is. See the documentation for more details.

default: "bytes"
Allowed:[object Object][object Object][object Object][object Object]
transforms.InsertStaticKey1.static.fieldstring

The name of the static field to be added to the message key.

transforms.InsertStaticKey1.static.valuestring

The value of the static field to be added to the message key.

transforms.InsertStaticValue1.static.fieldstring

The name of the static field to be added to the message value.

transforms.InsertStaticValue1.static.valuestring

The value of the static field to be added to the message value.

transforms.InsertStaticKey2.static.fieldstring

The name of the static field to be added to the message key.

transforms.InsertStaticKey2.static.valuestring

The value of the static field to be added to the message key.

transforms.InsertStaticValue2.static.fieldstring

The name of the static field to be added to the message value.

transforms.InsertStaticValue2.static.valuestring

The value of the static field to be added to the message value.

predicates.IsTopicToEnrich.patternstring

Regex pattern to match topics for enrichment.

default: "$^"
streamkap.snapshot.parallelisminteger

How many parallel chunk requests to send to the source DB.

min 1 · max 50 · default: 1
streamkap.snapshot.chunk.size.bytesinteger

Target byte size for one chunk SELECT. Drives LIMIT = ceil(chunk.size.bytes / avg_row_size).

min 4096 · max 8388608 · default: 524288
streamkap.snapshot.max.split.size.bytesinteger

A table whose on-disk size exceeds this splits into ceil(size / threshold) disjoint ctid page-range sub-ranges so it doesn't monopolize one snapshot worker. Applies only to unfiltered ctid snapshots. Default 50 GiB.

min 10485760 · max 214748364800 · default: 53687091200
streamkap.snapshot.state.refresh.msinteger

Executor publish cadence (ms) - how often the parallel-snapshot executor publishes SourceSnapshotState (rows_scanned, status transitions) to the streamkap_state topic. Lower values surface progress faster at the cost of state-topic traffic.

min 1000 · max 60000 · default: 30000
ssh.enabledboolean

<span>Streamkap will connect to SSH server in your network which has access to your database. This is necessary if Streamkap cannot connect directly to your database. <a href='https://docs.streamkap.com/streamkap-ip-addresses#streamkap-ip-addresses' class='docs-url' target='_blank'>View the Streamkap IP addresses to allowlist on your SSH server</a> </span>

default: false
ssh.hoststringrequired

Hostname of your SSH server

ssh.portstringrequired

Port of your SSH server

default: "22"
ssh.userstringrequired

User that allows Streamkap to connect to SSH server

default: "streamkap"
ssh.public.key.user.displayedstringrequired

Public key to add to SSH server

default: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJVbRrHqNN3SyIYnNF46SMd+ArZz+QheAtjnQzKiBWrc"
S3SourceConfig
transforms.ValueToKey.fields.include.liststring

Move column(s) from value to key. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ValueToKey.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
InsertTopicName.enabledboolean

Add _streamkap_topic field containing the Kafka topic name. Required for topic_router transforms to preserve end-to-end data lineage.

default: false
formatstring

The input file format

default: "json"
Allowed:jsoncsvavro
csv.has.headersboolean

When enabled, treat the first row of each CSV file as column names. When disabled, columns are auto-generated as column1, column2, ...

default: true
topic.routing.enabledboolean

When enabled, derive the Kafka topic name per file from the S3 key. When disabled, all files go to the single default topic.

default: false
topic.routing.folder.skipinteger

Number of leading path segments to drop from the S3 key before using folders for the topic name. Example: with key 'archive/public/users/file.csv' set 2 to drop 'archive/public'.

min 0 · default: 0
topic.routing.folder.levelsinteger

Number of folder segments (after the skip) to include in the topic name, joined with dots. Set 0 to skip folder-based routing entirely.

min 0 · default: 0
topic.routing.advanced.expressionstring

ScEL expression for building the topic suffix. When set, overrides Folder Skip and Folder Levels. The connector ID is always prepended. See the S3 Source documentation for available functions and examples.

default: ""
topic.postfixstring

The default topic name suffix. When Dynamic Topic Routing is disabled, all files are streamed to this single topic. When enabled, this is used as a fallback for files that do not match the routing rules.

default: "default"
topic.include.list.user.definedstring

Topics produced by this S3 source. Populated automatically as topics are discovered.

default: ""
aws.access.key.idstringrequired

The AWS Access Key ID used to connect to S3

default: ""
aws.secret.access.keystring<password>required

The AWS Secret Access Key used to connect to S3

default: ""
aws.s3.regionstring

The AWS region to be used

default: "us-west-2"
Allowed:[object Object][object Object][object Object][object Object][object Object][object Object][object Object][object Object][object Object][object Object][object Object][object Object]
aws.s3.bucket.namestring

The S3 Bucket to use

default: ""
aws.s3.bucket.prefixstring

Prefix for S3 object keys to scan (e.g. "data/2024/"). Can be used to specify a directory.

default: "file-pulse/"
fs.scan.interval.msinteger

The interval in milliseconds at which to scan for new files.

min 100 · max 100000 · default: 10000
fs.cleanup.policy.class.user.definedstring

The policy to use for cleaning up files after processing. Log marks files as processed without deleting. Delete removes files from S3 after processing.

default: "Log"
Allowed:LogDelete
tasks.maxinteger

The maximum number of active tasks

min 1 · max 10 · default: 5
SQLServerSourceConfig
transforms.ValueToKey.fields.include.liststring

Move column(s) from value to key. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ValueToKey.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
InsertTopicName.enabledboolean

Add _streamkap_topic field containing the Kafka topic name. Required for topic_router transforms to preserve end-to-end data lineage.

default: false
database.hostname.user.definedstringrequired

The Endpoint of the SQL Server database server. For example, sqlserverdb.abcdefgh.us-west-2.rds.amazonaws.com

database.port.user.definedstringrequired

SQL Server Port. For example, 1433

default: "1433"
database.encryptboolean

Use TLS encryption with the SQL Server?

default: true
database.userstringrequired

Username to access the database

database.passwordstring<password>required

Password to access the database

database.namesstringrequired

Database to stream from.

schema.include.liststringrequired

Schemas to include.

table.include.list.user.definedstringrequired

Source tables to sync.

signal.data.collection.schema.or.databasestringrequired

Path to the signal table as schema.table (e.g., 'dbo.streamkap_signal'). The database name will be added automatically. This table is used for incremental snapshotting.

default: "streamkap"
column.exclude.list.user.definedstring

An optional, comma-separated list of regular expressions that match the fully-qualified names of columns that should be excluded from change event record values. Fully-qualified names for columns are of the form schemaName.tableName.columnName.

heartbeat.enabledboolean

When enabled, the connector emits a periodic heartbeat to a Kafka topic — this keeps the poll loop active and offsets advancing on low-traffic sources, preventing replication-slot/log lag and false-positive health alerts. To also write to a 'streamkap_heartbeat' table in the source database (keeps the source transaction log moving), set 'Heartbeat Table Schema' below; leave it blank for Kafka-only mode.

default: true
heartbeat.data.collection.schema.or.databasestring

Optional. The schema containing a 'streamkap_heartbeat' table — providing this enables source-table heartbeat mode, which writes to the table on each beat to keep the source transaction log active. Leave blank for Kafka-only heartbeat (no table or write grant required). See the Streamkap documentation for table setup.

schema.history.internal.store.only.captured.databases.ddlstring

Specifies whether the connector records schema structures from all logical databases in the database instance or only captured databases. Enabling this when you have many databases in your instance can improve performance and avoid timeouts.

default: false
schema.history.internal.store.only.captured.tables.ddlstring

Specifies whether the connector records schema structures from all logical tables in the captured schemas or databases, or only captured tables. Enabling this when you have many tables can improve performance and avoid timeouts.

default: false
binary.handling.modestring

Specifies how the data for binary columns e.g. blob, binary, varbinary should be represented. This setting depends on what the destination is. See the documentation for more details.

default: "bytes"
Allowed:[object Object][object Object][object Object][object Object]
streamkap.snapshot.parallelisminteger

How many parallel chunk requests to send to the source DB.

min 1 · max 50 · default: 1
streamkap.snapshot.chunk.size.bytesinteger

Target byte size for one chunk SELECT. Drives LIMIT = ceil(chunk.size.bytes / avg_row_size).

min 4096 · max 8388608 · default: 524288
streamkap.snapshot.max.split.size.bytesinteger

A table with an estimated size greater than max split size will trigger intra-table paralelism. Table will be split into max.split.size.bytes parts and the parts will be processed in parallel.

min 10485760 · max 214748364800 · default: 53687091200
streamkap.snapshot.state.refresh.msinteger

Executor publish cadence (ms) — how often the parallel-snapshot executor publishes SourceSnapshotState (rows_scanned, status transitions) to the streamkap_state topic. Lower values surface progress faster at the cost of state-topic traffic.

min 1000 · max 60000 · default: 30000
ssh.enabledboolean

<span>Streamkap will connect to SSH server in your network which has access to your database. This is necessary if Streamkap cannot connect directly to your database. <a href='https://docs.streamkap.com/streamkap-ip-addresses#streamkap-ip-addresses' class='docs-url' target='_blank'>View the Streamkap IP addresses to allowlist on your SSH server</a> </span>

default: false
ssh.hoststringrequired

Hostname of your SSH server

ssh.portstringrequired

Port of your SSH server

default: "22"
ssh.userstringrequired

User that allows Streamkap to connect to SSH server

default: "streamkap"
transforms.InsertStaticKey1.static.fieldstring

The name of the static field to be added to the message key.

transforms.InsertStaticKey1.static.valuestring

The value of the static field to be added to the message key.

transforms.InsertStaticValue1.static.fieldstring

The name of the static field to be added to the message value.

transforms.InsertStaticValue1.static.valuestring

The value of the static field to be added to the message value.

ssh.public.key.user.displayedstringrequired

Public key to add to SSH server

default: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJVbRrHqNN3SyIYnNF46SMd+ArZz+QheAtjnQzKiBWrc"
SalesforceSourceConfig
transforms.ValueToKey.fields.include.liststring

Move column(s) from value to key. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ValueToKey.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
InsertTopicName.enabledboolean

Add _streamkap_topic field containing the Kafka topic name. Required for topic_router transforms to preserve end-to-end data lineage.

default: false
webhook.urlstring

Webhook URL for Apex triggers. Generated after source is created.

default: ""
api.keystring<password>

API Key for webhook authentication. Generated after source is created.

default: "<API_KEY>"
camel.source.snapshot.salesforce.instance.urlstringrequired

Salesforce instance URL (e.g., https://myorg.my.salesforce.com or https://myorg.lightning.force.com)

default: ""
camel.source.snapshot.salesforce.auth.client.idstringrequired

OAuth2 Consumer Key from your Salesforce Connected App / External Client App

default: ""
camel.source.snapshot.salesforce.auth.client.secretstring<password>required

OAuth2 Consumer Secret from your Salesforce Connected App / External Client App

default: ""
camel.source.snapshot.salesforce.auth.usernamestring

Salesforce username (optional, needed only if client_credentials flow is not enabled)

default: ""
camel.source.snapshot.salesforce.auth.passwordstring<password>

Salesforce password + security token (optional, needed only if client_credentials flow is not enabled)

default: ""
topic.include.list.user.definedstring

Salesforce objects to capture. Select the objects you want to receive change events for.

default: "Account,Contact,Lead,Opportunity"
camel.source.cdc.enabledboolean

Enable native Salesforce CDC subscription. When enabled, the connector subscribes directly to Salesforce change events without needing Apex triggers.

default: true
camel.source.payload.router.unknown.type.behaviorstring

How to handle events for unselected objects

default: "DEFAULT_TOPIC"
Allowed:DEFAULT_TOPICSKIPFAIL
camel.source.payload.router.unknown.type.default.topicstring

Topic for events from unselected objects

default: "unknown"
camel.source.payload.router.flatten.detailboolean

Flatten nested record fields to top-level. Recommended for most destinations.

default: true
camel.source.payload.router.flatten.detail.prefixstring

Prefix for flattened fields (empty = no prefix, Salesforce field names like 'Name', 'BillingCity' are used directly)

default: ""
camel.source.payload.router.include.eventboolean

Include change metadata (ChangeEventHeader) in output. Disable for upsert/state-table use cases.

default: false
camel.source.dlq.enabledboolean

Enable dead letter queue for failed records

default: true
ShopifySourceConfig
transforms.ValueToKey.fields.include.liststring

Move column(s) from value to key. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ValueToKey.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
InsertTopicName.enabledboolean

Add _streamkap_topic field containing the Kafka topic name. Required for topic_router transforms to preserve end-to-end data lineage.

default: false
webhook.urlstring

Webhook URL to register in Shopify. Generated after source is created. Pass the API key as a query parameter, e.g. ?api_key=<API_KEY>.

default: ""
api.keystring

API Key. Append to the Webhook URL as ?api_key=<API_KEY> when registering webhooks in Shopify. Generated after source is created.

default: "<API_KEY>"
camel.source.snapshot.shopify.store.urlstring

Shopify store URL (e.g., https://yourstore.myshopify.com). Required for snapshots.

default: ""
camel.source.snapshot.shopify.client.idstring

Client ID from your Shopify Dev Dashboard app (recommended). Tokens auto-refresh every 24 hours.

default: ""
camel.source.snapshot.shopify.client.secretstring<password>

Client Secret from your Shopify Dev Dashboard app (recommended). Encrypted at rest.

default: ""
camel.source.snapshot.shopify.access.tokenstring<password>

Static access token (legacy custom apps only). Provide either Client ID + Client Secret OR this Access Token.

default: ""
camel.source.snapshot.shopify.api.versionstring

Shopify Admin API version used by snapshots.

default: "2024-10"
camel.source.payload.router.shopify.hmac.secretstring<password>

Shopify app client secret used to verify the X-Shopify-Hmac-Sha256 header. Leave empty to skip verification.

default: ""
topic.include.list.user.definedstring

Shopify resources to capture. Each resource maps to a Kafka topic. Fan-out topics are added automatically when fan-out fields are configured.

default: "orders,products,customers"
camel.source.payload.router.unknown.type.behaviorstring

How to handle events for resources not in the Shopify Resources list

default: "DEFAULT_TOPIC"
Allowed:DEFAULT_TOPICSKIPFAIL
camel.source.payload.router.unknown.type.default.topicstring

Topic for events from unselected resources (used when Unselected Resource Behavior is DEFAULT_TOPIC)

default: "unknown"
camel.source.payload.router.include.eventboolean

Include Shopify webhook metadata (_shop_domain, _event_id, _triggered_at, _api_version, _webhook_id) in output records. Disable for upsert / state-table use cases.

default: false
camel.source.payload.router.fanout.fieldsstring

Comma-separated list of nested arrays to fan out into their own topics (e.g. orders.line_items, products.variants, customers.addresses). When empty, arrays stay inline.

default: ""
camel.source.dlq.enabledboolean

Enable dead letter queue for failed records

default: true
StripeSourceConfig
transforms.ValueToKey.fields.include.liststring

Move column(s) from value to key. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ValueToKey.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
InsertTopicName.enabledboolean

Add _streamkap_topic field containing the Kafka topic name. Required for topic_router transforms to preserve end-to-end data lineage.

default: false
webhook.urlstring

Webhook URL to register in Stripe. Generated after source is created. Pass the API key as a query parameter, e.g. ?api_key=<API_KEY>.

default: ""
api.keystring

API Key. Append to the Webhook URL as ?api_key=<API_KEY> when registering webhooks in Stripe. Generated after source is created.

default: "<API_KEY>"
camel.source.payload.router.stripe.signing.secretstring<password>

Stripe webhook signing secret (whsec_xxx). When set, every webhook is verified against the Stripe-Signature header. Leave empty to disable verification.

default: ""
camel.source.snapshot.stripe.api.keystring<password>

Stripe secret API key (sk_live_xxx or sk_test_xxx). Required for snapshots. Encrypted at rest.

default: ""
topic.include.list.user.definedstring

Stripe resources to capture. Each resource maps to a Kafka topic. Fan-out topics are added automatically when fan-out fields are configured.

default: "customer,payment_intent,charge,invoice"
camel.source.payload.router.unknown.type.behaviorstring

How to handle events for resources not in the Stripe Resources list

default: "DEFAULT_TOPIC"
Allowed:DEFAULT_TOPICSKIPFAIL
camel.source.payload.router.unknown.type.default.topicstring

Topic for events from unselected resources (used when Unselected Resource Behavior is DEFAULT_TOPIC)

default: "unknown"
camel.source.payload.router.include.eventboolean

Include Stripe event metadata (_event_id, _event_type, _event_created, _api_version, _livemode, _previous_attributes) on the output record. Disable for upsert / state-table use cases.

default: true
camel.source.payload.router.fanout.fieldsstring

Comma-separated list of nested lists to fan out into their own topics. Allowed: invoice.lines, charge.refunds, subscription.items.

default: ""
camel.source.dlq.enabledboolean

Enable dead letter queue for failed records

default: true
SupabaseSourceConfig
transforms.ValueToKey.fields.include.liststring

Move column(s) from value to key. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ValueToKey.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
InsertTopicName.enabledboolean

Add _streamkap_topic field containing the Kafka topic name. Required for topic_router transforms to preserve end-to-end data lineage.

default: false
database.hostname.user.definedstringrequired

PostgreSQL Hostname. For example, postgres.something.rds.amazonaws.com

database.port.user.definedstringrequired

PostgreSQL Port. For example, 5432

default: "5432"
database.userstringrequired

Username to access the database

database.passwordstring<password>required

Password to access the database

database.dbnamestringrequired

Database from which to stream data

snapshot.read.only.user.definedstring

When connecting to a read replica PostgreSQL database, this must be set to 'Yes' to support Streamkap snapshots

default: "Yes"
Allowed:YesNo
signal.data.collection.schema.or.databasestringrequired

Full path to the signal table including schema and table name (e.g., 'public.streamkap_signal'). This table is used for incremental snapshotting. Follow the documentation for creating this table.

column.include.list.toggledboolean

Toggle between Inclusion (include only selected columns) and Exclusion (exclude selected columns). Defaults to Inclusion (On).

default: true
column.include.list.user.definedstring

An optional, comma-separated list of regular expressions that match the fully-qualified names of columns that should be included in change event record values. Fully-qualified names for columns are of the form schemaName[.]tableName[.](columnName1|columnName2)

column.exclude.list.user.definedstring

An optional, comma-separated list of regular expressions that match the fully-qualified names of columns that should be excluded from change event record values. Fully-qualified names for columns are of the form schemaName.tableName.columnName.

heartbeat.enabledboolean

When enabled, the connector emits a periodic heartbeat to a Kafka topic — this keeps the poll loop active and offsets advancing on low-traffic sources, preventing replication-slot/log lag and false-positive health alerts. To also write to a 'streamkap_heartbeat' table in the source database (keeps the source transaction log moving), set 'Heartbeat Table Schema' below; leave it blank for Kafka-only mode.

default: true
heartbeat.data.collection.schema.or.databasestring

Optional. The schema containing a 'streamkap_heartbeat' table — providing this enables source-table heartbeat mode, which writes to the table on each beat to keep the source transaction log active. Leave blank for Kafka-only heartbeat (no table or write grant required). See the Streamkap documentation for table setup.

slot.namestringrequired

The name of the replication slot for the connector to use.

default: "streamkap_pgoutput_slot"
publication.namestringrequired

The name of the publication for the connector to use.

default: "streamkap_pub"
schema.include.liststringrequired

Schemas to include.

table.include.list.user.definedstringrequired

Source tables to sync.

reselector.reselect.error.handling.modestring

Controls what happens when the re-select post processor fails to fetch a column. 'Fail' stops the connector; 'Warn' logs a warning and continues.

default: "fail"
Allowed:failwarn
post.processors.reselect.enabledboolean

When enabled, TOAST columns that cannot be read from the WAL are re-fetched from the source database at event time.

default: true
database.sslmodestring

Whether to use an encrypted connection to the PostgreSQL server

default: "require"
Allowed:requiredisable
include.source.db.name.in.table.name.user.definedboolean

Changes the format of topics to 'DatabaseName_TopicName'

default: false
binary.handling.modestring

Specifies how the data for binary columns e.g. blob, binary, varbinary should be represented. This setting depends on what the destination is. See the documentation for more details.

default: "bytes"
Allowed:[object Object][object Object][object Object][object Object]
transforms.InsertStaticKey1.static.fieldstring

The name of the static field to be added to the message key.

transforms.InsertStaticKey1.static.valuestring

The value of the static field to be added to the message key.

transforms.InsertStaticValue1.static.fieldstring

The name of the static field to be added to the message value.

transforms.InsertStaticValue1.static.valuestring

The value of the static field to be added to the message value.

transforms.InsertStaticKey2.static.fieldstring

The name of the static field to be added to the message key.

transforms.InsertStaticKey2.static.valuestring

The value of the static field to be added to the message key.

transforms.InsertStaticValue2.static.fieldstring

The name of the static field to be added to the message value.

transforms.InsertStaticValue2.static.valuestring

The value of the static field to be added to the message value.

predicates.IsTopicToEnrich.patternstring

Regex pattern to match topics for enrichment.

default: "$^"
ssh.enabledboolean

<span>Streamkap will connect to SSH server in your network which has access to your database. This is necessary if Streamkap cannot connect directly to your database. <a href='https://docs.streamkap.com/streamkap-ip-addresses#streamkap-ip-addresses' class='docs-url' target='_blank'>View the Streamkap IP addresses to allowlist on your SSH server</a> </span>

default: false
ssh.hoststringrequired

Hostname of your SSH server

ssh.portstringrequired

Port of your SSH server

default: "22"
ssh.userstringrequired

User that allows Streamkap to connect to SSH server

default: "streamkap"
ssh.public.key.user.displayedstringrequired

Public key to add to SSH server

default: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJVbRrHqNN3SyIYnNF46SMd+ArZz+QheAtjnQzKiBWrc"
VitessSourceConfig
transforms.ValueToKey.fields.include.liststring

Move column(s) from value to key. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ValueToKey.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
InsertTopicName.enabledboolean

Add _streamkap_topic field containing the Kafka topic name. Required for topic_router transforms to preserve end-to-end data lineage.

default: false
database.hostname.user.definedstringrequired

IP address or hostname of the Vitess database server (VTGate).

database.port.user.definedstringrequired

Integer port number of the Vitess database server (VTGate).

default: "15991"
database.userstringrequired

An optional username of the Vitess database server (VTGate). If not configured, unauthenticated VTGate gRPC is used.

database.passwordstring<password>required

An optional password of the Vitess database server (VTGate). If not configured, unauthenticated VTGate gRPC is used.

vitess.keyspace.user.definedstringrequired

The name of the keyspace from which to stream the changes.

vitess.tablet.typestring

The type of Tablet (hence MySQL) from which to stream the changes

default: "MASTER"
Allowed:MASTERREPLICARDONLY
vitess.vtctld.host.user.definedstringrequired

IP address or hostname of the VTCtld server.

vitess.vtctld.port.user.definedstringrequired

Integer port number of the VTCtld server.

default: "15999"
vitess.vtctld.userstringrequired

The username of the VTCtld server.

vitess.vtctld.passwordstring<password>required

The password of the VTCtld database server.

table.include.list.user.definedstringrequired

Source tables to sync.

ssh.enabledboolean

<span>Streamkap will connect to SSH server in your network which has access to your database. This is necessary if Streamkap cannot connect directly to your database. <a href='https://docs.streamkap.com/streamkap-ip-addresses#streamkap-ip-addresses' class='docs-url' target='_blank'>View the Streamkap IP addresses to allowlist on your SSH server</a> </span>

default: false
ssh.hoststringrequired

Hostname of your SSH server

ssh.portstringrequired

Port of your SSH server

default: "22"
ssh.userstringrequired

User that allows Streamkap to connect to SSH server

default: "streamkap"
column.exclude.list.user.definedstring

An optional, comma-separated list of regular expressions that match the fully-qualified names of columns that should be excluded from change event record values. Fully-qualified names for columns are of the form schemaName.tableName.columnName.

ssh.public.key.user.displayedstringrequired

Public key to add to SSH server

default: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJVbRrHqNN3SyIYnNF46SMd+ArZz+QheAtjnQzKiBWrc"
WebhookSourceConfig
transforms.ValueToKey.fields.include.liststring

Move column(s) from value to key. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ValueToKey.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
InsertTopicName.enabledboolean

Add _streamkap_topic field containing the Kafka topic name. Required for topic_router transforms to preserve end-to-end data lineage.

default: false
webhook.urlstring

Webhook URL. This URL will be generated after the source is created

default: ""
api.keystring

API. This key will be generated after the source is created

default: "<API_KEY>"
camel.source.camelMessageHeaderKeystring

Camel Message Header contains key field details for Kafka Message, default is 'key'

default: "key"
topic.include.list.user.definedstring

Topic names to use as output

default: "default_topic"
formatstring

The incoming format of the data receive by webhook

default: "json"
Allowed:jsonstring
transforms.inferSchema.add.delete.fieldboolean

Whether to add a 'delete' field to the schema when DELETE HTTP method is used

default: false
ZendeskWebhookSourceConfig
transforms.ValueToKey.fields.include.liststring

Move column(s) from value to key. Comma separated list of table columns in format 'table1.column1,table2.column2'

transforms.ValueToKey.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
preserve.null.valuesboolean

When enabled, preserves NULL values from the source database instead of replacing them with schema default values. Enable this if you need to distinguish between explicit NULLs and default values.

default: false
transforms.OversizedRecords.fields.include.liststring

Truncate or nullify oversized string fields. Comma separated list of table columns in format 'table1.column1,table2.column2'. Supports wildcards (e.g., 'mytable.*'). WARNING: Do not include primary key columns - truncation/nullification could cause data loss or failures.

transforms.OversizedRecords.fields.exclude.liststring

Columns to exclude from oversized records processing. Comma separated list in format 'table1.column1,table2.column2'.

transforms.OversizedRecords.max.field.size.bytesinteger

Maximum allowed byte size per field. Fields exceeding this size will be truncated or nullified. Required when using Oversized Records transform.

min 1048576 · max 104857600 · default: 1048576
transforms.OversizedRecords.oversized.field.behaviorstring

Action for oversized fields: TRUNCATE (trim to max size) or NULLIFY (set to null).

default: "TRUNCATE"
Allowed:TRUNCATENULLIFY
transforms.OversizedRecords.truncation.suffixstring

Suffix to append to truncated values (e.g., '...[TRUNCATED]'). Leave empty for no suffix.

default: ""
transforms.OversizedRecords.max.record.size.bytesinteger

Optional overall record size limit in bytes. Records are NOT dropped - only a warning is logged if record exceeds this after field processing. Set to -1 to disable.

min -1 · max 104857600 · default: -1
transforms.OversizedRecords.semantic.types.excludestring

Column data types that should never be truncated. Comma-separated. Defaults exclude JSON and XML columns.

default: "io.debezium.data.Json,io.debezium.data.Xml"
transforms.OversizedRecords.replace.null.with.defaultboolean

Whether null fields should use schema default values. Set to false to preserve user-set NULLs from source.

default: true
InsertTopicName.enabledboolean

Add _streamkap_topic field containing the Kafka topic name. Required for topic_router transforms to preserve end-to-end data lineage.

default: false
webhook.urlstring

Webhook URL. This URL will be generated after the source is created

default: ""
api.keystring<password>

API Key. This key will be generated after the source is created

default: "<API_KEY>"
camel.source.payload.router.unknown.type.behaviorstring

Behavior when an unknown Zendesk event type is encountered

default: "DEFAULT_TOPIC"
Allowed:DEFAULT_TOPICSKIPFAIL
camel.source.payload.router.unknown.type.default.topicstring

Topic name for unknown event types (used when Unknown Event Behavior is DEFAULT_TOPIC)

default: "unknown"
camel.source.payload.router.flatten.detailboolean

Flatten nested detail fields to top-level with a prefix. Recommended for destinations that do not support nested objects.

default: false
camel.source.payload.router.flatten.detail.prefixstring

Prefix for flattened detail fields to avoid name collisions (e.g. detail.id becomes detail_id)

default: "detail_"
camel.source.payload.router.include.eventboolean

Include the event field in output records. Enable for audit-log use cases (append mode). Disable for state-table use cases (upsert mode) where only the entity state matters.

default: true
camel.source.payload.router.fanout.fieldsstring

Comma-separated list of domain-scoped fields to fan out into separate topics (e.g. ticket.tags, ticket.custom_fields, organization.tags). When empty, arrays stay inline.

default: ""
camel.source.dlq.enabledboolean

Enable dead letter queue. Failed records are written to a DLQ topic instead of crashing the connector.

default: false
any
any
topic_idsstring | integer[] | any

List of associated topic identifiers

Show properties
Any of:
string | integer[]
Array of string | integer
Any of:
string
string
integer
integer
any
any
topic_mapobject | any

Mapping of topics to their partitions or related entities

Show properties
Any of:
object
object
any
any
topicsstring | integer[] | any

List of topic names

Show properties
Any of:
string | integer[]
Array of string | integer
Any of:
string
string
integer
integer
any
any
tasksinteger[] | any

List of task identifiers

Show properties
Any of:
integer[]
Array of integer
integer
any
any
connector_statusstring | any

Current status: Active, Paused, Stopped, Broken, Starting, Unassigned, Unknown, Pending

Show properties
Any of:
string
string
any
any
desired_statestring | any

Desired state: Pending, Active, Paused, Stopped

Show properties
Any of:
string
string
any
any
kc_cluster_idstring | any

KC cluster this connector is deployed to. None means default cluster.

Show properties
Any of:
string
string
any
any
task_statusesobject | any

Status information for each connector task

Show properties
Any of:
object
object
any
any
tagsstring[] | any

List of tag IDs assigned to this source

Show properties
Any of:
string[]
Array of string
string
any
any
422

Validation Error

detailValidationError[]
Show properties
Array of ValidationError
locstring | integer[]required
Show properties
Array of string | integer
Any of:
string
string
integer
integer
msgstringrequired
typestringrequired
inputany
ctxobject
Request
curl -X GET "https://api.streamkap.com/sources" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "connector": [
    "string"
  ],
  "status": [
    "string"
  ],
  "snapshot": [
    "string"
  ],
  "stale": true,
  "tag_ids": [
    "string"
  ],
  "tag_filter_operation": "and"
}'
Response
{
  "page": 1,
  "page_size": 10,
  "total": 0,
  "has_next": true,
  "result": [
    {
      "name": "string",
      "connector": "string",
      "id": "string",
      "connector_display_name": "string",
      "created_timestamp": "string",
      "sub_id": "string",
      "tenant_id": "string",
      "service_id": "string",
      "config": {
        "transforms.ValueToKey.fields.include.list": "string",
        "transforms.ValueToKey.replace.null.with.default": true,
        "preserve.null.values": false,
        "transforms.OversizedRecords.fields.include.list": "string",
        "transforms.OversizedRecords.fields.exclude.list": "string",
        "transforms.OversizedRecords.max.field.size.bytes": 1048576,
        "transforms.OversizedRecords.oversized.field.behavior": "TRUNCATE",
        "transforms.OversizedRecords.truncation.suffix": "",
        "transforms.OversizedRecords.max.record.size.bytes": -1,
        "transforms.OversizedRecords.semantic.types.exclude": "io.debezium.data.Json,io.debezium.data.Xml",
        "transforms.OversizedRecords.replace.null.with.default": true,
        "InsertTopicName.enabled": false,
        "database.hostname.user.defined": "string",
        "database.port.user.defined": "5432",
        "database.user": "string",
        "database.password": "pa$$word",
        "database.dbname": "string",
        "snapshot.read.only.user.defined": "Yes",
        "signal.data.collection.schema.or.database": "string",
        "column.include.list.toggled": true,
        "column.include.list.user.defined": "string",
        "column.exclude.list.user.defined": "string",
        "heartbeat.enabled": true,
        "heartbeat.data.collection.schema.or.database": "string",
        "slot.name": "streamkap_pgoutput_slot",
        "publication.name": "streamkap_pub",
        "schema.include.list": "string",
        "table.include.list.user.defined": "string",
        "reselector.reselect.error.handling.mode": "fail",
        "post.processors.reselect.enabled": true,
        "database.sslmode": "require",
        "include.source.db.name.in.table.name.user.defined": false,
        "binary.handling.mode": {
          "value": "bytes",
          "label": "Bytes"
        },
        "transforms.InsertStaticKey1.static.field": "string",
        "transforms.InsertStaticKey1.static.value": "string",
        "transforms.InsertStaticValue1.static.field": "string",
        "transforms.InsertStaticValue1.static.value": "string",
        "transforms.InsertStaticKey2.static.field": "string",
        "transforms.InsertStaticKey2.static.value": "string",
        "transforms.InsertStaticValue2.static.field": "string",
        "transforms.InsertStaticValue2.static.value": "string",
        "predicates.IsTopicToEnrich.pattern": "$^",
        "ssh.enabled": false,
        "ssh.host": "string",
        "ssh.port": "22",
        "ssh.user": "streamkap",
        "ssh.public.key.user.displayed": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJVbRrHqNN3SyIYnNF46SMd+ArZz+QheAtjnQzKiBWrc"
      },
      "topic_ids": [
        "string"
      ],
      "topic_map": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      },
      "topics": [
        "string"
      ],
      "tasks": [
        0
      ],
      "connector_status": "string",
      "desired_state": "string",
      "kc_cluster_id": "string",
      "task_statuses": {
        "property1": {
          "property1": "string",
          "property2": "string"
        },
        "property2": {
          "property1": "string",
          "property2": "string"
        }
      },
      "tags": [
        "string"
      ]
    }
  ]
}