Trigger a Webhook (GET)

Receives a webhook callback via HTTP GET 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. A sync route can return a status other than 200. A sync run whose execution failed answers 502 on every response view, so the caller can redeliver. The passthrough response view relays the provider’s status and body only when the run completed, which means the status is in the step’s success_status_codes. A set_output node’s responseStatusCode can set the status of a completed run.

GET /v1/webhooks/{path}

Trigger a Webhook (GET)

cURL

curl --request GET \
  --url https://flowker.sandbox.lerian.net/v1/webhooks/{path} \
  --header 'Authorization: Bearer <token>'

200

{
  "executionId": "f7e6d5c4-b3a2-1098-7654-321fedcba098",
  "workflowId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "completed",
  "stepResults": [
    {
      "stepNumber": 1,
      "stepName": "Set Payment Output",
      "nodeId": "set-output",
      "status": "completed",
      "output": {
        "actionType": "set_output",
        "output": {
          "status": "received"
        }
      },
      "executedAt": "2026-03-17T14:35:00Z",
      "durationMs": 0
    }
  ],
  "finalOutput": {
    "status": "received"
  },
  "startedAt": "2026-03-17T14:35:00Z",
  "completedAt": "2026-03-17T14:35:00Z"
}

Autorizaciones

Authorization · string · header · requerido

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

Encabezados

Idempotency-Key · string

Optional idempotency key. A repeated key replays the first execution while it exists: an execution with a write step is kept without a time limit; a read-only one may be deleted after the retention window, after which the same key starts a new execution.

Parámetros de ruta

path · string · requerido

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

Respuesta

200

application/json

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.

Ejemplo:

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

executionId · string<uuid>

Unique identifier of the execution.

Ejemplo:

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

finalOutput · object

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

Ejemplo:

{ "status": "received" }

startedAt · string<date-time>

Timestamp when the execution started.

Ejemplo:

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

status · string

Final status of the execution.

Ejemplo:

"completed"

stepResults · object[]

Ordered list of results for each step executed.

Show child attributes

workflowId · string<uuid>

ID of the workflow that was executed.

Ejemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"