SDK reference

Introduction

Turn business processes into data-driven insight.

Mark a process in TypeScript. See its volume, duration, success rate, and the result each execution reported.

const run = flowmark.workflow("invoice.import", { properties: { batchId } })
run.step("source-loaded", { properties: { count: 1000 } })
run.done({ result: { imported: 988, skipped: 12 } })

This is an instrumentation sketch. The quickstart shows where the markers belong around real work, including failure handling and delivery.

Install

npm i @flowmarkdev/node

Then open the quickstart to create a client and mark a process.

Start here

Your goalRead this
Record your first executionQuickstart
Understand workflows, runs, and outcomesCore concepts
See what the dashboard measuresInsights
Instrument a Next.js serverNext.js integration
Track browser interactionsBrowser integration
Look up a method or typeSDK reference
Run the stack locallyLocal development

Insights you can use

  • Volume: how often a process runs, including daily counts for 30 days.
  • Outcomes: success rate among finished runs, plus failed-run count.
  • Performance: median duration from start to done() or fail(), and per-operation timing on the timeline.
  • Progress: the last reported snapshot, such as 600 of 1,000 records.
  • Result: the business summary your code attached — imported, skipped, shipped, paid.

A completed import can still have skipped records. A failed order can already have captured a payment. Those facts sit on the same execution.

Current project status

Instrument a process, ingest events, sign in, and inspect a run. The hosted reference deployment is at flowmark.dev / app.flowmark.dev / api.flowmark.dev. Install with npm i @flowmarkdev/node. Dashboard sign-in is email and password; sign-up creates a project and the first write key. Password reset is not available yet. Start with quickstart.

On this page