Per-table changefeed topic. On Kafka and Pub/Sub a topic is created per
source table by default (the table name). Each message represents a
committed row mutation in CockroachDB.
tableName — Source CockroachDB table name (also the destination topic name).
Operations
publish
tableRowChanged
A row in the table was inserted, updated, or deleted.
Messages
EnvelopeWrapped
Default envelope; contains "after" row state and optional "before", "key", "updated".
Content-Type: application/json
EnvelopeBare
Row columns at top level; CockroachDB metadata under "__crdb__".
Content-Type: application/json
EnvelopeKeyOnly
Primary key array only; no row payload.
Content-Type: application/json
EnvelopeRow
Row columns only; no metadata, no key, no envelope wrapper.
Content-Type: application/json
EnvelopeEnriched
Adds op code, ts_ns, and (with enriched_properties) source/schema
metadata. Operation codes: "c" (insert), "u" (update), "d" (delete).
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.