Skip to main content
PUT
Trigger a Webhook (PUT)

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider. Send it in the Authorization header as Bearer <token>.

Headers

Idempotency-Key
string

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

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

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

The workflow finished inside the synchronous window. The body carries the final business results. An XML route returns the equivalent <results> document.

completedAt
string<date-time>

Timestamp when the execution finished.

Example:

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

executionId
string<uuid>

Unique identifier of the execution.

Example:

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

finalOutput
object

Aggregated output from the last step or the workflow's final result.

Example:
startedAt
string<date-time>

Timestamp when the execution started.

Example:

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

status
string

Final status of the execution.

Example:

"completed"

stepResults
object[]

Ordered list of results for each step executed.

workflowId
string<uuid>

ID of the workflow that was executed.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"