Getting started

This guide takes you from an empty account to a job running through a process you designed.

Create your account

1. Go to the sign up page.
2. Enter your email address and choose a password.
3. Verify your email address.
4. Complete your profile.

Design a workflow

From your dashboard, open the workflows page and create a new one. The editor is a canvas.

• Add stages. Drag them onto the canvas.
• Connect them. Draw edges to say which stages must finish before the next can start.
• Describe each one. A name, instructions, and an estimated duration.

Publish it

Editing a published workflow creates a draft. Your changes are not live until you publish them, so you can take as long as you like over them.

• A banner appears above the canvas while a draft is open.
• Publish, optionally with a note describing what changed.
• Publishing mints a new version. Discard throws the draft away.

Run a job

A workflow is a template. Each piece of real work is a job created from it, which takes its own copy of the process.

1. Create a job from the jobs page, choosing the workflow it should follow.
2. Work through the stages, completing each one as it is done.
3. Add webhooks to be told as stages change state.

Get an API key

Everything above is available over the API.

1. Go to API keys.
2. Click Generate new key.
3. Copy it and store it somewhere safe. It is shown once.

An API key is not a bearer token. You exchange it for a JWT that lasts 15 minutes, and that JWT authorises your requests. The API reference covers the exchange and every endpoint, with samples you can run from the page.