SDK

A conceptual look at installing and using a FLOWTYPE client library.

The SDK is on the roadmap. The package name and methods below are placeholders that show the intended developer experience. Nothing is published.

Installation

Install (placeholder package)Demo example

npm install @flowtype/sdk

Initialise the client

client.tsDemo example

import { Flowtype } from '@flowtype/sdk';

const client = new Flowtype({ apiKey: process.env.FLOWTYPE_API_KEY });

Trigger a workflow

trigger.tsDemo example

const run = await client.workflows.trigger('customer-onboarding', {
  customer: 'Northwind Traders',
  plan: 'business',
});

// run.executionId → "demo_48291"

Handle events

events.tsDemo example

const event = client.webhooks.verify(body, signatureHeader, secret);

if (event.type === 'execution.failed') {
  await client.executions.retry(event.executionId);
}

Language support

Language	Status
TypeScript / JavaScript	Planned
Python	Planned
Other languages	Not scheduled

Custom connectors

A connector interface is planned so teams can wrap their own systems as workflow steps. It is a concept and has no published specification yet.