Flow.Documentation
ProfessionalWorkflows

API response: what the caller gets back

6 steps± 4 minVideoVerified 22 Oct 2026
  1. Step 1 · Open Flow and create a workflow
  2. Step 2 · Build the answer
  3. Step 3 · Put the steps in one line and save
  4. Step 4 · Try it in the Studio
  5. Step 5 · Publish the workflow as an endpoint
  6. Step 6 · Call the endpoint

When a workflow sits behind an endpoint, the API response step decides what the caller gets back: the HTTP status and the body, with data from the workflow. Without an API response the caller gets everything the workflow collected. You build the answer, publish the workflow as an endpoint and call it the way a consumer does.

Watch the whole guide as a video6 steps in one film
Step 1 / 6

Open Flow and create a workflow

In the portal, under Environments, click Development and there Open; Flow opens in a new tab. There, click ＋ next to General, choose New workflow and give it a name. A new workflow starts with an Event trigger: the point where it begins.

  1. Click Development
Open Flow and create a workflow · Click Development
  1. Click Open ↗
Open Flow and create a workflow · Click Open ↗
  1. Click Add to General
Open Flow and create a workflow · Click Add to General
  1. Click New workflow
Open Flow and create a workflow · Click New workflow
  1. In Workflow name, type Guide · sign-up received
Open Flow and create a workflow · In Workflow name, type Guide · sign-up received
Step 2 / 6

Build the answer

Put in the sample data what a caller sends along. Add API response. Choose the HTTP status: 201 means created. In the body (Code) you put what the caller gets back, with {{field}} for data from the request.

  1. Click the step ‘Event trigger’
Build the answer · Click the step ‘Event trigger’
  1. Click Code
Build the answer · Click Code
  1. In the sample data, type `{
Build the answer · In the sample data, type `{; ; ;
  1. Click Add node
Build the answer · Click Add node
  1. Click API response
Build the answer · Click API response
  1. In HTTP status, type 201
Build the answer · In HTTP status, type 201
  1. Click Code
Build the answer · Click Code
  1. In the body, type `{
Build the answer · In the body, type `{; ; ;
  1. Click the dot of ‘Event trigger’
Build the answer · Click the dot of ‘Event trigger’
  1. Click the dot of ‘API response’
Build the answer · Click the dot of ‘API response’
Step 3 / 6

Put the steps in one line and save

Select the steps (click the first, and the others while holding Shift) and click Align horizontally: they then stand in one line and you read the workflow from left to right; a branch (such as No of an If / Else) gets its own row below. Fit to view puts everything in sight; then Save.

  1. Click ‘Event trigger’
Put the steps in one line and save · Click ‘Event trigger’
  1. Click ‘API response’ while holding Shift
Put the steps in one line and save · Click ‘API response’ while holding Shift
  1. Click Align horizontally
Put the steps in one line and save · Click Align horizontally
  1. Click Fit to view
Put the steps in one line and save · Click Fit to view
  1. Click Save
Put the steps in one line and save · Click Save
Step 4 / 6

Try it in the Studio

Run: at the bottom you see the answer was prepared, with the status. Under Data after the run you see it as response.status and response.body.

  1. Click Run
Try it in the Studio · Click Run
Try it in the Studio · Status: Completed.
Try it in the Studio · Response 201 prepared.
Step 5 / 6

Publish the workflow as an endpoint

Press Esc: with no step selected, the Workflow settings are on the right. Under Publish as an endpoint you choose a new API, with a name; the method POST suits creating something. Click Publish: the endpoint opens.

  1. In API, choose ＋ New API…
  2. In Name of the new API, type Guide · sign-ups
Publish the workflow as an endpoint · In API, choose ＋ New API…; In Name of the new API, type Guide · sign-ups
Publish the workflow as an endpoint · POST and the path where the API will be reachable.
  1. Click Publish
Publish the workflow as an endpoint · Click Publish
Step 6 / 6

Call the endpoint

On the right is Try it: it calls the API as a consumer would, with a key (covered up here). Put in the body what the consumer sends and click Send. You get 201 back, with exactly the body from API response.

  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 Street", "people": 2}
Call the endpoint · In Body, type {"name": "Ada Street", "people": 2}
  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).