Flow.Documentation
Professional

Connect a partner's API

5 steps± 4 minVideoVerified 22 Oct 2026
  1. Step 1 · Open your development environment
  2. Step 2 · Open Connections
  3. Step 3 · Fill in the address and the key
  4. Step 4 · Create a workflow with an HTTP step
  5. Step 5 · Run and read the answer

Your supplier or partner has a REST API with a base address and a key. You record it once as a connection; the key stays encrypted on the server. From then on any workflow calls the API with just a path, without ever seeing the key. You need: the API's base address and a bearer token.

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

Open Connections

Connections are at the bottom of the explorer, for the whole workspace. At the top are the systems Flow has a ready-made connector for; for any other REST API you choose General HTTP API.

  1. Click Connections
Open Connections · Click Connections
  1. Click General HTTP API
Open Connections · Click General HTTP API
Step 3 / 5

Fill in the address and the key

The base URL is the part that is the same for every call. With Bearer token, Flow sends the key along as the Authorization header. Leave access on Read only if you only fetch data: Flow then refuses any call that would change something, even when a workflow or AI Colleague tries.

  1. In Name, type Partner · orders
  2. In Base URL, type http://127.0.0.1:62344/partner
  3. In Authentication, choose Bearer token
  4. In Secret, type ••••••••
Fill in the address and the key · In Name, type Partner · orders; In Base URL, type http://127.0.0.1:62344/partner; In Authentication, choose Bearer token; In Secret, type ••••••••
Fill in the address and the key · Access: read only.
  1. Click Save
Fill in the address and the key · Click Save
Fill in the address and the key · Your connection, with the key stored. It can never be read back, not even by you.
Step 4 / 5

Create a workflow with an HTTP step

Create a new workflow and add HTTP request. Choose your connection: the URL field then becomes the path after the base URL, and the key goes along by itself. Under Store the result as you name the answer.

  1. Click Add to General
Create a workflow with an HTTP step · Click Add to General
  1. Click New workflow
Create a workflow with an HTTP step · Click New workflow
  1. In Workflow name, type Order status at partner
Create a workflow with an HTTP step · In Workflow name, type Order status at partner
  1. Click Add node
Create a workflow with an HTTP step · Click Add node
  1. Click HTTP request
Create a workflow with an HTTP step · Click HTTP request
  1. In Connection, choose Partner · orders
  2. In URL or path, type /orders/1042
  3. In Store the result as, type partner
Create a workflow with an HTTP step · In Connection, choose Partner · orders; In URL or path, type /orders/1042; In Store the result as, type partner
  1. Click the dot of ‘Event trigger’
Create a workflow with an HTTP step · Click the dot of ‘Event trigger’
  1. Click the dot of ‘HTTP request’
Create a workflow with an HTTP step · Click the dot of ‘HTTP request’
Step 5 / 5

Run and read the answer

At the bottom you see the call and the status code; under Data after the run the answer is in partner.status and partner.body. Next steps read it as {{partner.body.…}}.

  1. Click Save
Run and read the answer · Click Save
  1. Click Run
Run and read the answer · Click Run
Run and read the answer · GET → 200: the partner answered.
Run and read the answer · The partner's answer in the run's data.

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