Warehouse Sync

Create warehouse sync

Changed on

Creates a sync that runs a query on a schedule and sends changed rows to Sequenzy: contacts (kind subscribers) through the import pipeline, or events on existing contacts (kind events). The mapping and cursor are checked against the query's real columns and the first run starts right away. Requires warehouse:write and subscribers:write; event syncs also need events:write, and triggerAutomations or double_opt_in need automations:trigger.

post/warehouse-syncs

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/warehouse-syncs
  • Auth
    HTTP bearer

Request body

connectionIdstring required
namestring required
kind'subscribers' | 'events' required
querystring required

A single SELECT or WITH statement.

cursorColumnstring nullable

Column read incrementally, for example updated_at. Each run reads rows at or after the last value it saw.

frequency'every_15_minutes' | 'hourly' | 'daily' | 'weekly' | 'manual'
listIdsstring[]

Subscriber syncs only. Lists new contacts join.

optInMode'confirmed' | 'double_opt_in'

Subscriber syncs only. double_opt_in needs automations:trigger.

triggerAutomationsboolean

Let new contacts, or events from the last hour, start automations. Needs automations:trigger.

Response

Sync created and first run queued

successboolean

Example response

{
  "success": true
}

Changes