For the complete documentation index, see llms.txt. This page is also available as Markdown.

The tabs

Every tool tab in the editor: Test, Connectors, Contract, Diagram, Test cases, Executions, Sync reports, API and Docs.

Test

The Test tab with a ctx.input editor holding saleId, isRetry, syncMode, purchaseId and connection_id, a ctx.headers editor, and Use contract, a Live selector and Run Live above them
Until you run it, the result pane just reads Hit Run to execute without saving.

Two JSON editors, ctx.input and ctx.headers. Use contract fills the input from the declared contract. The mode select beside the run button chooses what the run actually calls:

Mode
What runs

Live

Real calls to the connected systems.

Partial Mock

A mix of real calls and stubs.

Fully Mock

Stubs only.

Then Run Live (or Run).

Connectors

The Connectors tab listing two extracted connectors (Cin7 Core with getSale, listCustomers and listProducts, and Trackstar with createOrder, getOrder, listOrders and more), both badged Per customer
Every action chip carries its pinned version, such as getSale V1.1.

This list is auto-extracted from the fastn.connectors.X.Y(…) calls in your code every time you save. It is a readout of the code, not a separate configuration. Add exists for anything you need to wire manually. Each row shows a Per customer badge where it applies, plus the connector slug, the owning org, the action and its version.

Contract

The Contract tab stacking an Input contract of saleId, isRetry, syncMode, purchaseId and connection_id above an Output contract of log, message, notPorted and syncStatus, each with a JSON/Schema toggle
Both editors sit on JSON here; the Schema view holds the generated contract.

Input contract and Output contract, each viewable as JSON or Schema. Write an example payload in the JSON view and the schema is generated live. The schema is the contract, and is also hand-editable.

Diagram

Three sub-tabs.

Flow: a read-only React Flow rendering, generated from your code. Node kinds are TRIGGER, DECISION, READ and DONE; the controls are Zoom In, Zoom Out and Fit View. You cannot edit the graph. Edit the code and the graph follows.

Sequence: the same logic as an ordered list of phases.

Docs: generated documentation, with an End user / Technical toggle, an Out of date badge when the code has moved on, and Regenerate / Generate.

The end-user document has eight sections: What this integration does, Before you start, Connected apps, How it works, Field mapping, Smart features, When it runs, Troubleshooting.

Generating or regenerating these docs consumes AI credits from the workspace allowance shown in the top bar.

Test cases

Scenarios generated during the build, organised into groups: happy-path, pagination, fields, edge-cases, error-handling. The header carries pass, fail and untested counters. Each row is an id such as TC-01, a LIVE or MOCK badge, and the expectation.

Executions

This workflow's run history, filtered by status pills: All, 200, 201, 400, 404, 422, 500. The workspace-wide view is Activity → Executions.

Sync reports

A report appears the first time a workflow runs fastn.diff.compare.

See Sync reports.

API

The API tab with endpoint and curl
Generated from the deployment you are actually calling, copy the curl from here rather than from docs.

How to call this workflow over HTTP, with a copyable curl:

Two headers steer it (X-fastn-Test-Mode and x-fastn-env) and you authenticate with an API key in the fsk_live_… format. Covered in full in the HTTP API reference.

Docs

The runtime reference for the code you are writing:

Surface
For

ctx.input

The request body, shaped by the input contract.

ctx.headers

The request headers.

ctx.connectors

The connectors wired to this workflow.

fastn.envConfig

Per-environment values. See Configs.

fastn.unified

The unified API surface.

fastn.connector

A connector call.

fastn.db

The workspace Postgres schema. See Database.

fastn.state

Key/value state, with scopes ORG and INVOCATION.

fastn.secrets

Encrypted values. See Secrets.

Multi-tenant calls are addressed with headers: x-end-org-id, x-end-org-ref, x-installation-id, x-fastn-connections, x-fastn-installation-config.

This tab uses fastn.connector (singular) while the Connectors tab extracts from fastn.connectors.X.Y(…) (plural). Both spellings appear in the product; check the Docs tab in your own workspace before relying on either.

Fuller treatment in Workflow runtime API.

Last updated

Was this helpful?