From a95776891e66869c53846ca7155e3b5b50edffdd Mon Sep 17 00:00:00 2001 From: lemoer Date: Thu, 26 Jun 2025 17:40:40 +0200 Subject: [PATCH] website/docs: add hint that flows need cookies (#15252) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * website/docs: add hint that flows need cookies The executor itself does not set a session cookie, but requires one to be set before. This took me days to figure out, so maybe this will be helpful to somebody in the future. Signed-off-by: Leonardo Mörlein * Update website/docs/developer-docs/api/flow-executor.md Signed-off-by: Dewi Roberts --------- Signed-off-by: Leonardo Mörlein Signed-off-by: Dewi Roberts Co-authored-by: Dewi Roberts --- website/docs/developer-docs/api/flow-executor.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/website/docs/developer-docs/api/flow-executor.md b/website/docs/developer-docs/api/flow-executor.md index bd39b28873..7c510faf51 100644 --- a/website/docs/developer-docs/api/flow-executor.md +++ b/website/docs/developer-docs/api/flow-executor.md @@ -10,6 +10,10 @@ However, any flow can be executed via an API from anywhere, in fact that is what Because the flow executor stores its state in the HTTP Session, so you need to ensure that cookies between flow executor requests are persisted. ::: +:::info +Note that the HTTP session must be obtained as a cookie before `GET /api/v3/flows/executor/:slug` can be called. If you are using a JWT for authentication, you first have to obtain a session cookie via `GET /api/v3/flows/instances/:slug/execute/` before requesting `GET /api/v3/flows/executor/:slug`. +::: + The main endpoint for flow execution is `/api/v3/flows/executor/:slug`. This endpoint accepts a query parameter called `query`, in which the flow executor sends the full query-string.