Flow.Documentation
ProfessionalAPIs

An endpoint that forwards to a connection

4 steps± 3 minVideoVerified 22 Oct 2026
  1. Step 1 · Open your development environment
  2. Step 2 · An endpoint that forwards
  3. Step 3 · Call it
  4. Step 4 · Path parameters go along

With Forward to connection you put an existing system behind your own API, without a workflow in between. The consumer sees your address and your security; Flow forwards the request with the key from the connection, which the consumer never sees. Path parameters such as {id} go along to the upstream path.

Watch the whole guide as a video4 steps in one film
Step 1 / 4

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 / 4

An endpoint that forwards

Open the API and click ＋ Endpoint. Under What it does choose Forward to connection, the connection with the existing system and the upstream path: the path after that connection's base URL. Save.

  1. Click the API
An endpoint that forwards · Click the API
  1. Click ＋ Endpoint
An endpoint that forwards · Click ＋ Endpoint
  1. In Name, type Stock
  2. In Method, choose GET
  3. In Path, type /stock
An endpoint that forwards · In Name, type Stock; In Method, choose GET; In Path, type /stock
  1. Click Forward to connection
An endpoint that forwards · Click Forward to connection
  1. In Connection, choose Bakery · partner API
  2. In Upstream path, type /stock
An endpoint that forwards · In Connection, choose Bakery · partner API; In Upstream path, type /stock
  1. Click Save endpoint
An endpoint that forwards · Click Save endpoint
An endpoint that forwards · Access: API key — the API's policy.
Step 3 / 4

Call it

Under Try it you call the endpoint with an API key of your API. Flow checks that key, forwards the request with the connection's key and returns the system's answer unchanged.

  1. In Key or token, type ••••••••
Call it · In Key or token, type ••••••••
  1. Click ▶ Send
Call it · Click ▶ Send
Call it ·
Call it · The stock, straight from the partner's system.
Step 4 / 4

Path parameters go along

A second endpoint with {id} in the path, and {id} in the upstream path too: Flow fills in the consumer's value. That way you offer one order without the consumer knowing the system's address.

  1. Click the API
Path parameters go along · Click the API
  1. Click ＋ Endpoint
Path parameters go along · Click ＋ Endpoint
  1. In Name, type Order
  2. In Method, choose GET
  3. In Path, type /orders/{id}
Path parameters go along · In Name, type Order; In Method, choose GET; In Path, type /orders/{id}
  1. Click Forward to connection
Path parameters go along · Click Forward to connection
  1. In Connection, choose Bakery · partner API
  2. In Upstream path, type /orders/{id}
Path parameters go along · In Connection, choose Bakery · partner API; In Upstream path, type /orders/{id}
  1. Click Save endpoint
Path parameters go along · Click Save endpoint
  1. In Key or token, type ••••••••
  2. In {id}, type 1042
Path parameters go along · In Key or token, type ••••••••; In {id}, type 1042
  1. Click ▶ Send
Path parameters go along · Click ▶ Send
Path parameters go along · Order 1042 from the partner.

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