> ## Documentation Index
> Fetch the complete documentation index at: https://docs.craftkit.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Inbound render trigger

> Inbound webhook trigger authenticated by the per-template token in the
URL. The JSON body becomes the variable input for a render. Optional
HMAC verification: if the `x-craftkit-signature` header is present it must
be the hex HMAC-SHA256 of the raw body using the template's
`inboundSecret`. Not bearer-authed.




## OpenAPI

````yaml /openapi.yaml post /v1/hooks/{token}
openapi: 3.1.0
info:
  title: Craftkit API
  version: 1.0.0
  description: >
    The Craftkit public REST API. Design templates with typed variables, render

    PDFs asynchronously, share and track them, and send them out for digital

    signature.


    ## Authentication


    Most endpoints authenticate with a **project API key** as a bearer token:


    ```

    Authorization: Bearer ck_live_xxxxxxxxxxxxxxxx

    ```


    Keys come in `ck_live_` (production) and `ck_test_` (test) flavours. Embed

    iframe surfaces use a short-lived **embed session JWT** instead, and the

    admin provisioning endpoint uses the deployment-wide `CRAFTKIT_ADMIN_KEY`.

    Inbound webhooks (`/v1/hooks/*`) are not bearer-authed — they are verified
    by

    an HMAC signature header.


    ## Idempotency


    `POST /v1/templates/{slug}/render` and `POST /v1/signatures` accept an

    `Idempotency-Key` request header. Retrying with the same key returns the

    original resource instead of creating (and, for signatures, billing) a

    duplicate.


    ## Errors


    Application errors use a shared envelope:


    ```json

    { "error": { "code": "invalid_request", "message": "...", "issues": { } } }

    ```


    A small number of admin/embed endpoints return a flatter shape

    (`{ "error": "invalid_credentials" }`); those are documented inline.
servers:
  - url: https://api.craftkit.dev
    description: Production
security:
  - bearerApiKey: []
tags:
  - name: Templates
    description: Create, list, fetch, republish, delete templates and enqueue renders.
  - name: Renders
    description: Poll render status, download PDFs, manage shares, email, and engagement.
  - name: Signatures
    description: >-
      Send rendered PDFs out for digital signatures via the signature service
      and track status.
  - name: Webhooks
    description: Inbound webhook receivers (HMAC-authenticated, not bearer-authed).
  - name: Embed
    description: Embed session minting, catalogs, builder templates, form submission.
  - name: Admin
    description: Org provisioning (deployment admin key only).
  - name: System
    description: Health and status.
paths:
  /v1/hooks/{token}:
    post:
      tags:
        - Webhooks
      summary: Inbound render trigger
      description: >
        Inbound webhook trigger authenticated by the per-template token in the

        URL. The JSON body becomes the variable input for a render. Optional

        HMAC verification: if the `x-craftkit-signature` header is present it
        must

        be the hex HMAC-SHA256 of the raw body using the template's

        `inboundSecret`. Not bearer-authed.
      operationId: inboundTemplateWebhook
      parameters:
        - name: token
          in: path
          required: true
          description: The template's inbound webhook token.
          schema:
            type: string
        - name: x-craftkit-signature
          in: header
          required: false
          description: >-
            Optional hex HMAC-SHA256 of the raw request body, keyed by the
            template inbound secret.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              description: Variable input matching the template's manifest.
            example:
              customer:
                name: Acme Corp
      responses:
        '202':
          description: Render queued.
          content:
            application/json:
              schema:
                type: object
                required:
                  - id
                  - status
                  - pollUrl
                properties:
                  id:
                    type: string
                    format: uuid
                  status:
                    type: string
                    enum:
                      - queued
                  pollUrl:
                    type: string
                    format: uri
              example:
                id: 3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6071
                status: queued
                pollUrl: >-
                  https://api.craftkit.dev/v1/renders/3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6071
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          description: HMAC signature mismatch.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: invalid_signature
                  message: HMAC signature mismatch.
        '404':
          description: Unknown inbound webhook token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: invalid_token
                  message: Unknown inbound webhook token.
        '409':
          description: Template has no published version yet.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Render queue temporarily unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security: []
components:
  responses:
    BadRequest:
      description: Invalid JSON or request shape.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: invalid_request
              message: Request body did not match expected shape.
  schemas:
    Error:
      type: object
      description: Shared application error envelope.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            issues:
              description: Optional Zod flatten() / issues detail.
      example:
        error:
          code: invalid_request
          message: Request body did not match expected shape.
  securitySchemes:
    bearerApiKey:
      type: http
      scheme: bearer
      description: >
        Project API key (`ck_live_…` or `ck_test_…`) presented as a bearer
        token.

        For embed partner endpoints this is the partner secret key, which is the

        same credential type.

````