--- title: "Set up destination schema" method: POST path: "/pipeline_setup" tags: ["Stateless Sync API"] --- # Set up destination schema `POST /pipeline_setup` Creates destination tables and applies migrations. Streams NDJSON messages (control, log, trace) tagged with _emitted_by. Pass only=destination to run destination setup alone (e.g. optimistic table creation) or only=source to isolate the source. ## Request body - object - `pipeline` PipelineConfig, required - `source` union, required - object - `type` 'stripe', required - `stripe` SourceStripeConfig, required - `api_key` string, required — Stripe API key (sk_test_... or sk_live_...) - `account_id` string — Stripe account ID (resolved from API if omitted) - `account_created` integer — Stripe account creation timestamp in unix seconds (resolved from API if omitted) - `livemode` boolean — Whether this is a live mode sync - `api_version` '2026-03-25.dahlia' | '2026-02-25.clover' | '2026-01-28.clover' | '2025-12-15.clover' | '2025-11-17.clover' | '2025-10-29.clover' | '2025-09-30.clover' | '2025-08-27.basil' | '2025-07-30.basil' | '2025-06-30.basil' | '2025-05-28.basil' | '2025-04-30.basil' | '2025-03-31.basil' | '2025-02-24.acacia' | '2025-01-27.acacia' | '2024-12-18.acacia' | '2024-11-20.acacia' | '2024-10-28.acacia' | '2024-09-30.acacia' | '2024-06-20' | '2024-04-10' | '2024-04-03' | '2023-10-16' | '2023-08-16' | '2022-11-15' | '2022-08-01' | '2020-08-27' | '2020-03-02' | '2019-12-03' | '2019-11-05' | '2019-10-17' | '2019-10-08' | '2019-09-09' | '2019-08-14' | '2019-05-16' | '2019-03-14' | '2019-02-19' | '2019-02-11' | '2018-11-08' | '2018-10-31' | '2018-09-24' | '2018-09-06' | '2018-08-23' | '2018-07-27' | '2018-05-21' | '2018-02-28' | '2018-02-06' | '2018-02-05' | '2018-01-23' | '2017-12-14' | '2017-08-15' - `base_url` string, uri — Override the Stripe API base URL (e.g. http://localhost:12111 for stripe-mock) - `webhook_url` string, uri — URL for managed webhook endpoint registration - `webhook_secret` string — Webhook signing secret (whsec_...) for signature verification - `websocket` boolean — Enable WebSocket streaming for live events - `poll_events` boolean — Enable events API polling for incremental sync after backfill - `webhook_port` integer — Port for built-in webhook HTTP listener (e.g. 4242) - `revalidate_objects` string[] — Object types to re-fetch from Stripe API on webhook (e.g. ["subscription"]) - `backfill_limit` integer — Max objects to backfill per stream (useful for testing) - `rate_limit` integer — Override max requests per second (default: auto-derived from API key mode — 20 live, 10 test). - object - `type` 'metronome', required - `metronome` SourceMetronomeConfig, required - `api_key` string, required — Metronome API bearer token - `base_url` string, uri — Override the Metronome API base URL (default: https://api.metronome.com) - `rate_limit` integer — Max requests per second (default: no limit) - `backfill_limit` integer — Max records to fetch per stream (useful for testing) - `webhook_secret` string — Webhook signing secret for HMAC-SHA256 signature verification - `webhook_port` integer — Port for built-in webhook HTTP listener (e.g. 4243) - `destination` union, required - object - `type` 'postgres', required - `postgres` DestinationPostgresConfig, required - `url` string — Postgres connection string - `connection_string` string — Deprecated alias for url; prefer url - `schema` string — Target schema name (e.g. "stripe") - `batch_size` number — Records to buffer before flushing - `aws` object — AWS RDS IAM authentication config - `host` string, required — Postgres host for RDS IAM auth - `port` number — Postgres port for RDS IAM auth - `database` string, required — Database name for RDS IAM auth - `user` string, required — Database user for RDS IAM auth - `region` string, required — AWS region for RDS instance - `role_arn` string — IAM role ARN to assume (cross-account) - `external_id` string — External ID for STS AssumeRole - `ssl_ca_pem` string — PEM-encoded CA certificate for SSL verification (required for verify-ca / verify-full with a private CA) - object - `type` 'google_sheets', required - `google_sheets` DestinationGoogleSheetsConfig, required - `client_id` string — Google OAuth2 client ID (env: GOOGLE_CLIENT_ID) - `client_secret` string — Google OAuth2 client secret (env: GOOGLE_CLIENT_SECRET) - `access_token` string, nullable - `refresh_token` string, required — OAuth2 refresh token - `spreadsheet_id` string — Target spreadsheet ID (created if omitted) - `spreadsheet_title` string — Title when creating a new spreadsheet - `batch_size` number — Rows per Sheets API append call - object - `type` 'redis', required - `redis` DestinationRedisConfig, required - `url` string — Redis connection URL (redis://host:port) - `host` string — Redis host (default: localhost) - `port` number — Redis port (default: 6379) - `password` string — Redis password - `db` number — Redis database number (default: 0) - `tls` boolean — Enable TLS - `key_prefix` string — Prefix for all Redis keys (default: empty) - `batch_size` number — Records to buffer before flushing via pipeline - `streams` object[] - `name` string, required — Stream (table) name to sync. - `sync_mode` 'incremental' | 'full_refresh' — How the source reads this stream. Defaults to full_refresh. - `fields` string[] — If set, only these fields are synced. - `backfill_limit` integer — Cap backfill to this many records, then mark the stream complete. - `only` 'source' | 'destination' — Run only the source or destination side. Useful for optimistic destination setup or isolating a connector when debugging. ## Response `200` NDJSON stream of setup messages ## Other responses - `400` — Invalid params ## Changes - **2026-04-30** `4b2cc3fc8044` — 4 info - added the new optional request property `pipeline/source/oneOf[subschema #2]/metronome/webhook_port` - added the new optional request property `pipeline/source/oneOf[subschema #2]/metronome/webhook_secret` - added the optional property `oneOf[#/components/schemas/ControlMessage]/control/oneOf[subschema #1]/source_config/oneOf[#/components/schemas/SourceMetronomeConfig]/webhook_port` to the response with the `200` status - added the optional property `oneOf[#/components/schemas/ControlMessage]/control/oneOf[subschema #1]/source_config/oneOf[#/components/schemas/SourceMetronomeConfig]/webhook_secret` to the response with the `200` status - **2026-04-30** `3b4bee18fd4d` — 1 breaking, 3 info - added `subschema #1, subschema #2` to the `oneOf[#/components/schemas/ControlMessage]/control` response property `oneOf` list for the response status `200` - added `subschema #2` to the `pipeline/source` request property `oneOf` list - added `subschema #3` to the `pipeline/destination` request property `oneOf` list - removed `subschema #1, subschema #2` from the `oneOf[#/components/schemas/ControlMessage]/control` response property `oneOf` list for the response status `200` - **2026-04-27** `7b4cf2bfcc81` — 1 breaking, 2 warning - added required request body - deleted the `header` request parameter `x-pipeline` - deleted the `query` request parameter `only` - …earlier changes not shown [Full history](https://skmtc.dev/stripe/apis/stripe-sync-engine/changes/pipeline_setup/post.md) --- [API](https://skmtc.dev/stripe/apis/stripe-sync-engine.md) · [All operations](https://skmtc.dev/stripe/apis/stripe-sync-engine/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/stripe/stripe-sync-engine/revisions/4b2cc3fc8044/schema)