FLfloqer
Sources

Sync Source to Workflow

Connect a created source to a workflow and (by default) backfill the workflow with the source's existing rows. source_instance_id is the UUID returned by Create.

field_mapping keys are public workflow input references (input.<field>); each value is the source field NAME to pull — the row's top-level key exactly as it appears in the Preview response (e.g. Name, email, business_id), NEVER a nested path like Name.value. The import resolves each field's value automatically, including for sources whose preview cells render as {label, value}. Each key is resolved to the matching workflow input. Keys are CASE-SENSITIVE — use the exact lowercase snake_case reference from List Inputs (minus the {{ }}); variants like Input.Email or input.firstName return 400. Surrounding {{ }} is tolerated.

push_existing (default true) toggles the backfill. Whether landed rows execute the workflow — backfilled and future rows alike — is the sheet's auto_run toggle: set it with Update Sheet (PATCH /api/v1/workflows/{workflow_id}/sheets/{sheet_id}) before syncing, and use Run Rows for explicit row_ids. The legacy run field is deprecated: it is accepted, ignored, and reported in warnings[].

post/api/v1/sources/{source_instance_id}/sync

Request

  • Base URL
    http://localhost:3009
  • Auth
    HTTP bearer

Path parameters

source_instance_idstring required

Source instance UUID (the source_instance_id returned by Create).

Request body

workflow_idstring uuid required

UUID of the destination workflow.

field_mappingobject required

Map of workflow input reference → source field, e.g. { "input.email": "email", "input.first_name": "firstname" }. Keys are input.<field> references from the workflow's inputs; values are source field names. Keys are CASE-SENSITIVE and must be the exact lowercase snake_case form returned by List Inputs (the input's reference without the {{ }} braces) — e.g. input.first_name, not Input.First_Name or input.firstName. Surrounding {{ }} is tolerated; case/spelling variants are not, and return 400 unknown input.

push_existingboolean

Whether to backfill the workflow with the source's current rows. Defaults to true.

runstring

Deprecated and ignored (reported in warnings[]). Whether landed rows execute is the sheet's auto_run toggle — set it with Update Sheet before syncing. Will be rejected in a future release.

Response

Default Response

statusinteger

Changes

No recorded changes to this operation across all 1 revision of this API.