Skip to main content
POST
Create a source connector

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Path Parameters

project_id
string
required

Body

application/json
name
string
required
type
enum<string>
required
Available options:
postgres,
mysql,
http
dataset
string
required

Dataset the polled rows land in.

Pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,62}$
config
any
required

Connector config (connection + query). Stored AES-256-GCM encrypted and never returned. Any non-null JSON value is accepted; shape is not validated here.

cursor_column
string | null

Watermark column. Defaults to null.

poll_interval
integer

Seconds. Clamped up to the plan minimum (free 3600, Pro 60); a non-numeric or missing value becomes the plan minimum.

Response

Created.

id
string
required