---
title: "workflow.run.webhook event"
method: POST
path: "workflow.run.webhook"
---

# workflow.run.webhook event

`POST workflow.run.webhook` (webhook)

Signed with `PDFBetter-Signature: t=<unix>,v1=<hex HMAC-SHA256(secret, `${t}.${body}`)>`. Respond with any 2xx within 10 seconds.

## Headers

- `PDFBetter-Signature` string, required

## Payload

- object
  - `id` string, required: evt_…; use it to de-duplicate
  - `type` 'workflow.run.webhook', required
  - `created` integer, required: Unix seconds
  - `data` object, required
    - `name` string, required: The event name you gave the Send webhook step (e.g. `invoice.ready`)
    - `run` object, required
      - `id` string, required
      - `workflowId` string, required
      - `documentId` string, required
      - `step` integer, required: 1-based position of the webhook step

## Acknowledgement `2XX`

Acknowledged. Anything else (or no answer in 10 s) is retried.

---

[API](https://skmtc.dev/pdfbetter/apis/pdfbetter-api.md) · [All operations](https://skmtc.dev/pdfbetter/apis/pdfbetter-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pdfbetter/apis/pdfbetter-api/revisions/6960b18754a8?raw)