v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Webhooks API

Trigger a Webhook (PUT)

Receives a webhook callback via HTTP PUT and triggers the associated workflow execution. The path is dynamically resolved against the webhook registry — each workflow can register its own webhook path. The runtime accepts GET, POST, PUT, PATCH, and DELETE on this route, as well as nested paths with multiple segments.

put/v1/webhooks/{path}

Path parameters

pathstring required

Webhook path registered by a workflow. Supports nested paths with multiple segments at runtime. Forward slashes within the path must be percent-encoded as %2F per RFC 3986/OpenAPI 3.1 (for example, use orders%2Fpaid for orders/paid).

Headers

Idempotency-Keystring

Optional idempotency key to prevent duplicate executions from the same webhook delivery.

X-Webhook-Tokenstring

Per-webhook verification token. Validated by the handler when configured on the webhook route.

Request body

object required

Webhook payload from the external system. Flowker injects webhook metadata (_webhook key with method, path, headers, query params, and remote IP) before passing to the workflow.

Response

Workflow execution completed synchronously (terminal state).

executionIdstring uuid

Unique identifier of the execution.

startedAtstring date-time

Timestamp when the execution started.

statusstring

Initial status of the execution (always pending).

workflowIdstring uuid

ID of the workflow being executed.

Example response

{
  "executionId": "f7e6d5c4-b3a2-1098-7654-321fedcba098",
  "startedAt": "2026-03-17T14:35:00Z",
  "status": "running",
  "workflowId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}