Flow.Documentation
ProfessionalAPIs

An endpoint that runs a workflow

5 steps± 4 minVideoVerified 22 Oct 2026
  1. Step 1 · Open your development environment
  2. Step 2 · Create an API
  3. Step 3 · Add a POST endpoint with a new workflow
  4. Step 4 · Decide the answer
  5. Step 5 · Call the endpoint

An API is a base path with one security policy; an endpoint binds one method and path to one workflow. What the consumer sends in the body is ready in the workflow as {{field}}; the step API response decides the status code and what they get back. You create an API with a POST endpoint, the workflow behind it, and call it.

Watch the whole guide as a video5 steps in one film
Step 1 / 5

Open your development environment

In the portal, under Environments, click Development, and there Open. Flow opens in a new tab and you are signed in straight away.

  1. Click Development
Open your development environment · Click Development
  1. Click Open ↗
Open your development environment · Click Open ↗
Step 2 / 5

Create an API

Click ＋ next to General and choose New API. The base path comes before every endpoint; by default the API asks for an API key.

  1. Click Add to General
Create an API · Click Add to General
  1. Click New API
Create an API · Click New API
  1. In Name, type Workshop
  2. In Base path, type /workshop
Create an API · In Name, type Workshop; In Base path, type /workshop
  1. Click Save API
Create an API · Click Save API
Create an API · In plain language: where the API lives and who may get in.
Step 3 / 5

Add a POST endpoint with a new workflow

＋ Endpoint, give it a name, method POST and a path. Under What it does choose Workflow, and click ＋ New workflow. Flow creates the workflow (trigger → API response), links it and opens it.

  1. Click ＋ Endpoint
Add a POST endpoint with a new workflow · Click ＋ Endpoint
  1. In Name, type Request an appointment
  2. In Method, choose POST
  3. In Path, type /appointments
Add a POST endpoint with a new workflow · In Name, type Request an appointment; In Method, choose POST; In Path, type /appointments
Add a POST endpoint with a new workflow · What it does: Workflow.
  1. Click ＋ New workflow
Add a POST endpoint with a new workflow · Click ＋ New workflow
Add a POST endpoint with a new workflow · The workflow: Event trigger → API response.
Step 4 / 5

Decide the answer

Fields from the request body are in the workflow as {{name}}. Click API response and set status 201 and a body that returns the name. Line up the steps and save.

  1. Click the step ‘API response’
Decide the answer · Click the step ‘API response’
  1. In HTTP status, type 201
Decide the answer · In HTTP status, type 201
  1. Click Code
Decide the answer · Click Code
  1. In Body, type `{
  2. We will call you to pick a time."
Decide the answer · In Body, type `{; We will call you to pick a time.";
  1. Click the step ‘Event trigger’
Decide the answer · Click the step ‘Event trigger’
  1. Click Align horizontally
Decide the answer · Click Align horizontally
  1. Click Save
Decide the answer · Click Save
Step 5 / 5

Call the endpoint

Open the endpoint in the explorer. On the right under Try it you call it like a consumer: with an API key that opens this API, and a body. You get the status code and your workflow's answer.

  1. Click the endpoint
Call the endpoint · Click the endpoint
  1. In Key or token, type ••••••••
Call the endpoint · In Key or token, type ••••••••
  1. Click Code
Call the endpoint · Click Code
  1. In Body, type {"name": "Ada"}
Call the endpoint · In Body, type {"name": "Ada"}
  1. Click ▶ Send
Call the endpoint · Click ▶ Send
Call the endpoint · 201: created.
Call the endpoint · Your workflow's answer, with the name from the request.

This guide was carried out step by step on 22 Oct 2026 by an automated test on Flow (version 3e563176).