Skip to main content
Create a Flow
curl --request POST \
  --url https://api.dots.dev/api/v2/flows \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "steps": [
    "compliance"
  ],
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "hide_go_to_dashboard_on_complete": false,
  "require_auth": false,
  "metadata": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "steps": [
    "compliance"
  ],
  "completed_steps": [
    "compliance"
  ],
  "link": "<string>",
  "metadata": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
steps
(enum<string> | Step With Options · object)[]
required

A list of steps. Can either be a string or an object with additional properties. Example: A redirect step looks like {"name": "redirect", "redirect_url": "https://example.com"}

​
user_id
string<uuid>

The user's id. If the user's ID is provided, the flow will be created in the authenticated state with a 15 minute expiration time unless the require_auth option is set to true.

​
hide_go_to_dashboard_on_complete
boolean
default:false

Hide the "Go to dashboard" button on the flow UI. Defaults to false.

​
require_auth
boolean
default:false

Require the user to be authenticated to complete the flow. Defaults to false.

​
metadata

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Response

200 - application/json

OK

​
id
string<uuid>

ID of the flow.

​
created
string<date-time>

Date that the flow was created.

​
user_id
string<uuid> | null

ID of the user that has claimed the flow.

​
steps
enum<string>[]

Array of steps in the flow.

​
completed_steps
enum<string>[]

Array of steps that have been completed in the flow.

​
link
string<uri>

URL to access the flow. Can be embedded in an iframe.

​
metadata

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

⌘I