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

# Trigger a Webhook

> Receives a webhook callback and triggers the associated workflow execution. The path is dynamically resolved against the webhook registry — each workflow can register its own webhook path. At runtime, GET, PUT, DELETE, and PATCH methods are also accepted, as well as nested paths with multiple segments.



## OpenAPI

````yaml /en/openapi/v3-current/flowker.yaml post /v1/webhooks/{path}
openapi: 3.1.0
info:
  description: >-
    Complete API reference for Flowker workflow orchestration services including
    catalog management, workflow definitions, executor configurations, provider
    configurations, and workflow executions.
  title: Flowker API
  version: 1.1.0
servers:
  - url: https://flowker.sandbox.lerian.net
security:
  - ApiKeyAuth: []
tags:
  - name: Health API
    description: Health and version endpoints for monitoring the Flowker service.
  - name: Catalog API
    description: >-
      Browse built-in providers, executors, and triggers available in the
      Flowker catalog.
  - name: Workflows API
    description: >-
      Create, update, activate, deactivate, clone, and delete workflow
      definitions.
  - name: Executions API
    description: Start workflow executions and track their status and results.
  - name: Executor Configurations API
    description: >-
      Configure, test, and manage external executor connections used by workflow
      nodes.
  - name: Provider Configurations API
    description: Configure, test, enable, and disable provider integrations.
  - name: Dashboard API
    description: >-
      Retrieve aggregated summaries of workflows and executions for operational
      dashboards.
  - name: Audit API
    description: Query and verify audit events for compliance and operational visibility.
  - name: Webhooks API
    description: >-
      Receive webhook callbacks from external systems to trigger workflow
      executions.
paths:
  /v1/webhooks/{path}:
    post:
      tags:
        - Webhooks API
      summary: Trigger a Webhook
      description: >-
        Receives a webhook callback and triggers the associated workflow
        execution. The path is dynamically resolved against the webhook registry
        — each workflow can register its own webhook path. At runtime, GET, PUT,
        DELETE, and PATCH methods are also accepted, as well as nested paths
        with multiple segments.
      operationId: triggerWebhook
      parameters:
        - description: >-
            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`).
          in: path
          name: path
          required: true
          schema:
            type: string
        - description: >-
            Optional idempotency key to prevent duplicate executions from the
            same webhook delivery.
          in: header
          name: Idempotency-Key
          schema:
            type: string
        - description: >-
            Per-webhook verification token. Validated by the handler when
            configured on the webhook route.
          in: header
          name: X-Webhook-Token
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              description: >-
                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.
        description: Webhook payload. Maximum size is 1 MB.
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionCreateOutput'
          description: Workflow execution completed synchronously (terminal state).
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionCreateOutput'
          description: Workflow execution created and running asynchronously.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Indicates that the request body is malformed or could not be parsed.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Unauthorized. Either the API key is invalid or the `X-Webhook-Token`
            header is missing or incorrect.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            No webhook registered for this path and HTTP method, or the
            associated workflow was not found.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Duplicate idempotency key — this webhook delivery was already
            processed.
        '413':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Webhook payload exceeds the 1 MB size limit.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            The associated workflow is not in an active state and cannot be
            executed.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indicates an unexpected internal error. If this persists, please
            contact support.
components:
  schemas:
    ExecutionCreateOutput:
      properties:
        executionId:
          description: Unique identifier of the execution.
          example: f7e6d5c4-b3a2-1098-7654-321fedcba098
          format: uuid
          type: string
        startedAt:
          description: Timestamp when the execution started.
          example: '2026-03-17T14:35:00Z'
          format: date-time
          type: string
        status:
          description: Initial status of the execution (always `pending`).
          example: running
          type: string
        workflowId:
          description: ID of the workflow being executed.
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
          format: uuid
          type: string
      type: object
    ErrorResponse:
      properties:
        code:
          description: Machine-readable error code with the FLK prefix.
          example: FLK-0001
          type: string
        message:
          description: Human-readable explanation of the error.
          example: Invalid input provided
          type: string
        title:
          description: Short error category title.
          example: Bad Request
          type: string
      required:
        - code
        - message
        - title
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key for authenticating requests to the Flowker API. Provisioned via
        the API_KEY environment variable during deployment.

````