Skip to content

Braidplane documentation

Braidplane connects systems through pipelines: what to read, how to transform it, and where to write the result. You can review each definition, deploy a version, and see what happened in every run.

Explore the platform

Start with the question your team needs to answer: which system holds the records, what needs to change or move, and where should the result go? Then create an Alpha account and choose the UI tutorial or CLI tutorial to connect a system you already use and run one connector-appropriate safe read.

If you do not have infrastructure, How Braidplane works is a reading tour that needs no account, CLI, database, or cloud bucket.

Then explore the connectors: see which systems you can connect, what each connector reads and writes, and its current limitations. When you are ready to connect a system, follow Connect a system.

Common workflow patterns

These are starting points for planning a workflow. They describe supported connector and pipeline shapes; run them with synthetic data in non-production systems during Alpha.

  • Database orders → mapped HubSpot properties: read order or customer records from a database such as MongoDB, normalize document objects to rows, then use a HubSpot upsert with a stable unique key and an explicit input-field-to-property mapping. The HubSpot guide shows the required property setup and mapping.
  • Joined JSON → S3: join compatible database rows or CSV files from GitHub, then write the result as a JSON object. The synthetic PostgreSQL-to-S3 walkthrough includes the pipeline file, expected rows, and prerequisites.
  • HTTP JSON → scheduled CSV in FTP: read an HTTP API response containing an object or array of objects, normalize it to rows, and attach an enabled schedule trigger to a deployed pipeline whose sink writes CSV to FTP. Schedule resources are managed for a project environment; the FTP guide documents CSV output and the connector's plain-FTP limits.
  • Snowflake ledger rows → CSV in S3: query the period's rows in Snowflake, keep the output contract row-shaped, and write CSV to a dedicated S3 key. The S3 guide documents structured row output and the explicit write format.

Each pattern still needs its own provider connection, permissions, bindings, deployment, and destination check. The pipeline specification reference explains those shared steps.

See Braidplane's future directions for current priorities and areas we may explore next. It is directional and not a delivery commitment.

The API reference describes the API available in this environment.

Before you connect anything

Braidplane Alpha runs in staging for evaluation with test data and non-production systems. Features and data may change or reset. Do not connect production systems or use production data. There is no SLA; keep your own source data and verify outputs. Do not provide sensitive data.

Read the pipeline specification reference before writing your own pipeline. The PostgreSQL-to-S3 example is a separate, complete walkthrough.

Alpha evaluation is free and requires no card. For a free consultation, email contact@braidplane.com.