Skip to main content
POST
Create a CDP reverse-ETL source

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
name
string
required
Maximum string length: 120
kind
enum<string>
required
Available options:
postgres,
bigquery,
snowflake,
databricks
connection
string
required

Warehouse connection string / credential blob; stored encrypted at rest and never returned.

sql_query
string
required

Read-only SELECT containing the {cursor} placeholder the scheduler binds to the incremental watermark.

cursor_column
string
required

Column whose max value advances the incremental cursor between runs.

event_name
string
default:warehouse.row

CDP event name each emitted row is recorded under.

schedule_minutes
integer
default:60
Required range: 5 <= x <= 1440
initial_cursor_value
string

Optional starting watermark; defaults to null (the query should COALESCE null to an epoch bound).

Response

200 - application/json

The created source's id.

data
object
meta
object