Skip to content

docs: document {data, meta} envelope in webhook responses #792

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
josephjclark merged 1 commit into from
May 21, 2026
Merged

docs: document {data, meta} envelope in webhook responses #792

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
43 changes: 36 additions & 7 deletions docs/build/triggers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,13 +77,32 @@ system waits — sometimes seconds or minutes — for the result.
- Headers:
- `x-meta-work-order-id` — the ID of the work order
- `x-meta-run-id` — the ID of the run
- Body: the final run state as a JSON object
- Body: a JSON object with the shape:
```json
{
"data": { /* the final run state */ },
"meta": {
"work_order_id": "abc123",
"run_id": "xyz456",
"state": "success",
"error_type": null,
"inserted_at": "2026-05-21T10:00:00Z",
"started_at": "2026-05-21T10:00:01Z",
"claimed_at": "2026-05-21T10:00:01Z",
"finished_at": "2026-05-21T10:00:05Z"
}
}
```
- `data` — the final run state (or a security message on failure, or a
custom body — see below)
- `meta` — run metadata, including run lifecycle timestamps and final
`state` (`"success"` or `"failed"`)

:::note Security policy for failed runs

When a run fails, OpenFn returns a generic message as the response body rather
than the full run state, to avoid leaking sensitive data. You can still return
a custom body from a failed run using `webhookResponse` (see below).
When a run fails, OpenFn returns a generic message in `data` rather than the
full run state, to avoid leaking sensitive data. You can still return a custom
body from a failed run using `webhookResponse` (see below).

:::

Expand All @@ -94,7 +113,7 @@ In sync mode you can set custom HTTP status codes on the trigger (under

- **Success Status Code** — returned when the run completes successfully
(defaults to `201`)
- **Error Status Code** — returned when the run fails (defaults to `500`)
- **Error Status Code** — returned when the run fails (defaults to `201`)

:::note Switching back to Async

Expand Down Expand Up @@ -126,17 +145,27 @@ Both `status` and `body` are **optional** — you can include either or both:
| Field | Behaviour when set |
| -------- | --------------------------------------------------------------- |
| `status` | Overrides the configured status code for this run |
| `body` | Replaces the final run state as the response body |
| `body` | Replaces the final run state under `data` in the response body |
| neither | Falls back to the configured status code and final run state |

`webhookResponse.body` only replaces the `data` portion of the response —
`meta` is always included by OpenFn. So the example above produces:

```json
{
"data": { "ack": true, "id": "..." },
"meta": { "work_order_id": "...", "run_id": "...", "state": "success", ... }
}
```

:::note Malformed values

If `webhookResponse` is not a JSON object (e.g. a string, number, or array), it
is ignored and the run's default status code and body apply.

If `webhookResponse.status` is not an integer, or `webhookResponse.body` is not
a JSON object, the response status falls back to the run's default (the
configured success or error code, or `201`/`500`) and the body is replaced with
configured success or error code, or `201`) and `data` is replaced with
`{ "message": "Run completed, but webhook_response was malformed: ..." }`.

:::
Expand Down