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.

Headers

Idempotency-Key
string

Makes a POST safe to retry for 24 hours: the same key, credential, path and body returns the stored response (Idempotent-Replayed: true) instead of running again. 422 if the key was used for a different request; 409 while the first is in flight.

Required string length: 1 - 255

Path Parameters

project_id
string
required

Body

application/json
name
string
required
dataset
string
required

Dataset the polled rows land in.

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

Stored AES-256-GCM encrypted and never returned.

cursor_column
string
required

Required: a column that only increases (an id, or an updated-at time). Each poll reads rows past the last value it saw, in its order.

Pattern: ^[A-Za-z_][A-Za-z0-9_]*$
type
enum<string>
default:postgres
Available options:
postgres
poll_interval
integer

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

Response

Created.

id
string
required
poll_interval
integer
required

Seconds, as stored: the request's interval clamped up to the plan minimum.

source
object

The created source, as GET by id returns it (#201).