Skip to content

docs: remove misleading example #5921

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aj-emerich merged 1 commit into from
Oct 9, 2026
Merged

docs: remove misleading example #5921

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions src/contents/docs/05.workflow-components/07.triggers/03.webhook-trigger/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ triggers:

## Webhook response

By default, the trigger responds immediately with JSON. When the caller needs to wait for the result — for example, a validation handshake that requires `text/plain` — enable `wait` and set `responseContentType`.
By default, the trigger responds immediately without waiting for the flow to finish. Set `wait: true` to hold the HTTP connection open until the execution completes (or the trigger's timeout is reached), and `returnOutputs: true` to include the flow outputs as a JSON object in the response body.

```yaml
triggers:
Expand All @@ -202,7 +202,6 @@ triggers:
key: "{{ secret('WEBHOOK_KEY') }}"
wait: true
returnOutputs: true
responseContentType: text/plain # optional, defaults to application/json
```

- `wait: true` keeps the HTTP connection open until the flow finishes or the trigger's timeout is reached.
Expand Down Expand Up @@ -232,12 +231,12 @@ triggers:
key: "{{ secret('WEBHOOK_KEY') }}"
wait: true
returnOutputs: true
# optional: responseContentType: "text/plain"
responseContentType: application/json # sets the Content-Type header only; body is always the JSON outputs map
```

- Call the webhook URL with a query parameter (for example `?name=Alice`). The execution runs synchronously because `wait: true` is set.
- The HTTP response body contains the flow outputs (JSON by default). With the example above, the response includes `"greeting": "Hello Alice!"`.
- Set `responseContentType: "text/plain"` when you want the response body to be plain text (ensure the flow returns a single string output, such as from the `Return` task).
- The HTTP response body contains the flow outputs as a JSON object. With the example above, the response includes `"greeting": "Hello Alice!"`.
- `responseContentType` sets the `Content-Type` header on the response. It does not change how the body is serialized — the body is always the JSON-serialized outputs map when `returnOutputs: true` is set.

## Test a webhook trigger

Expand Down
Loading