Skip to main content
PATCH
/
v1
/
webhooks
/
{path}
Trigger a Webhook (PATCH)
curl --request PATCH \
  --url https://flowker.sandbox.lerian.net/v1/webhooks/{path} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{}'
{
  "executionId": "f7e6d5c4-b3a2-1098-7654-321fedcba098",
  "startedAt": "2026-03-17T14:35:00Z",
  "status": "running",
  "workflowId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

API key for authenticating requests to the Flowker API. Provisioned via the API_KEY environment variable during deployment.

Headers

​
Idempotency-Key
string

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

​
X-Webhook-Token
string

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

Path Parameters

​
path
string
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).

Body

application/json

Webhook payload. Maximum size is 1 MB.

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).

​
executionId
string<uuid>

Unique identifier of the execution.

Example:

"f7e6d5c4-b3a2-1098-7654-321fedcba098"

​
startedAt
string<date-time>

Timestamp when the execution started.

Example:

"2026-03-17T14:35:00Z"

​
status
string

Initial status of the execution (always pending).

Example:

"running"

​
workflowId
string<uuid>

ID of the workflow being executed.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"