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

# Send a test event

> Sends a sample event to the endpoint now and returns the delivery with its attempt, so you can see what your receiver answered. Needs the Business plan or above. Limited to 10 a minute per endpoint. An endpoint made by an integration (`source: subscription`) is not found here.

The event has an ID starting with `evt_test_`, carries a fixed example shortcut (the Retrieve a sample event operation shows the same content), and is signed and sent like any other event. It is tried once, with no retries; it never counts towards disabling the endpoint, and it is sent even if the endpoint is switched off. The delivery appears in the endpoint's list of deliveries. If Lora's sender is busy with other deliveries of the endpoint, the delivery can still be `pending` when this answers.

The body may be left out; the default event is `shortcut.created`.



## OpenAPI

````yaml /openapi.json post /v1/webhooks/{id}/test
openapi: 3.1.0
info:
  title: Lora API
  version: 1.0.0
  description: >-
    Lora REST API for managing workspace shortcuts, folders, tags, webhook
    endpoints, and QR codes.


    ## Versioning

    All stable endpoints are prefixed with `/v1/`. Breaking changes ship under a
    new path prefix (for example `/v2/`).

    Non-breaking additions (new optional fields, new endpoints) may land in the
    current version.

    Deprecated endpoints are announced in the [developer
    docs](https://uselora.dev/essentials/versioning) before removal.


    ## Authentication

    Send `Authorization: Bearer <api_key>` on every request except `GET /v1/qr`,
    which also accepts anonymous callers. API keys are workspace-scoped and
    carry named scopes (for example `shortcuts.write`); each scoped operation's
    `security` requirement lists the one scope it needs (`GET /v1/qr` needs
    none), so request a key with only those.


    ## Errors

    4xx and 5xx responses use a typed JSON envelope: `{ error, code?, requestId,
    traceId?, fieldErrors?, required_scope?, current_plan?, required_capability?
    }`.

    See components `ErrorResponse`, `ErrorWithFieldErrors`,
    `PaymentRequiredError`, `ForbiddenError`, `PayloadTooLargeError`, and
    `InternalError`.


    ## Rate limits

    Successful responses include `RateLimit-Limit`, `RateLimit-Remaining`, and
    `RateLimit-Reset` (IETF RateLimit fields).

    429 responses include `Retry-After` (seconds). Authenticated callers are
    bucketed per API key; anonymous QR endpoints are bucketed per IP.


    ## Discovery

    - OpenAPI spec: `GET https://api.uselora.com/openapi.json` (also `GET
    https://api.uselora.com/`)

    - RFC 9727 catalog: `GET https://www.uselora.com/.well-known/api-catalog`

    - MCP manifest: `GET https://www.uselora.com/.well-known/mcp` (server card
    at `/.well-known/mcp/server-card.json`)

    - MCP Streamable HTTP endpoint: `POST https://api.uselora.com/mcp`
servers:
  - url: https://api.uselora.com
    description: Production
security:
  - bearerAuth: []
paths:
  /v1/webhooks/{id}/test:
    post:
      tags:
        - Webhooks
      summary: Send a test event
      description: >-
        Sends a sample event to the endpoint now and returns the delivery with
        its attempt, so you can see what your receiver answered. Needs the
        Business plan or above. Limited to 10 a minute per endpoint. An endpoint
        made by an integration (`source: subscription`) is not found here.


        The event has an ID starting with `evt_test_`, carries a fixed example
        shortcut (the Retrieve a sample event operation shows the same content),
        and is signed and sent like any other event. It is tried once, with no
        retries; it never counts towards disabling the endpoint, and it is sent
        even if the endpoint is switched off. The delivery appears in the
        endpoint's list of deliveries. If Lora's sender is busy with other
        deliveries of the endpoint, the delivery can still be `pending` when
        this answers.


        The body may be left out; the default event is `shortcut.created`.
      operationId: testWebhookEndpoint
      parameters:
        - description: The endpoint's unique ID, `wh_` and a UUID.
          in: path
          name: id
          required: true
          schema:
            example: wh_0198f2a4-7c1b-7d3e-9a52-3f6b1c2d4e5f
            pattern: ^wh_[0-9a-f-]{36}$
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestWebhookRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookDelivery'
          description: >-
            The test delivery, with its attempt. A receiver that answered with
            an error, or did not answer, is not an error of this request: look
            at the delivery's `status` and its attempt.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorWithFieldErrors'
          description: The body failed validation or was not valid JSON.
          headers:
            X-Lora-Request-Id:
              description: >-
                Request correlation identifier. Matches the `requestId` field in
                the JSON error body.
              schema:
                type: string
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Missing, malformed, unknown or revoked API key. A key that was
            disabled by a downgrade answers with `apikey_disabled`.
          headers:
            X-Lora-Request-Id:
              description: >-
                Request correlation identifier. Matches the `requestId` field in
                the JSON error body.
              schema:
                type: string
        '402':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentRequiredError'
          description: >-
            The workspace plan does not include webhooks
            (`plan_requires_upgrade`: Business and above).
          headers:
            X-Lora-Request-Id:
              description: >-
                Request correlation identifier. Matches the `requestId` field in
                the JSON error body.
              schema:
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: >-
            The key lacks the required scope (`insufficient_scope`, with
            `required_scope`), its owner is no longer an owner or admin of the
            workspace (`insufficient_role`), or its owner is no longer a member
            of the workspace (`no_permission`).
          headers:
            X-Lora-Request-Id:
              description: >-
                Request correlation identifier. Matches the `requestId` field in
                the JSON error body.
              schema:
                type: string
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Lora found no endpoint in this workspace.
          headers:
            X-Lora-Request-Id:
              description: >-
                Request correlation identifier. Matches the `requestId` field in
                the JSON error body.
              schema:
                type: string
        '413':
          description: >-
            The request body exceeded the size limit. The body is rejected
            before being parsed, so no partial write occurred; retrying with a
            smaller payload will succeed.
          headers:
            X-Lora-Request-Id:
              description: >-
                Request correlation identifier. Matches the `requestId` field in
                the JSON error body.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadTooLargeError'
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Rate limit exceeded (10 test sends a minute per endpoint). Wait
            `Retry-After` seconds before retrying.
          headers:
            Retry-After:
              description: Seconds until the rate-limit window resets.
              schema:
                type: integer
                minimum: 1
            X-Lora-Request-Id:
              description: >-
                Request correlation identifier. Matches the `requestId` field in
                the JSON error body.
              schema:
                type: string
        '500':
          description: >-
            An unexpected failure on the server. The body is `{ error:
            <message>, code: "internal_error", requestId: <id> }`, plus
            `traceId` when available. Retry idempotent operations with
            exponential backoff. A write may already have applied; reconcile its
            state before retrying.
          headers:
            X-Lora-Request-Id:
              description: >-
                Request correlation identifier. Matches the `requestId` field in
                the JSON error body.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
      security:
        - bearerAuth:
            - webhooks.write
components:
  schemas:
    TestWebhookRequest:
      type: object
      properties:
        event:
          $ref: '#/components/schemas/WebhookEventName'
          default: shortcut.created
          description: The event type to send a sample of. Defaults to `shortcut.created`.
      additionalProperties: false
      description: Options for a test send. The body may be left out.
    WebhookDelivery:
      type: object
      properties:
        attemptCount:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: How many attempts the delivery has had.
        attempts:
          type: array
          items:
            $ref: '#/components/schemas/WebhookAttempt'
          description: The attempts, oldest first.
        completedAt:
          description: When the delivery ended, or null while it is pending.
          type:
            - string
            - 'null'
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
        createdAt:
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
          description: When the delivery was queued, ISO 8601.
        endpointId:
          type: string
          pattern: ^wh_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
          description: The endpoint's unique ID.
          examples:
            - wh_0198f2a4-7c1b-7d3e-9a52-3f6b1c2d4e5f
        event:
          anyOf:
            - $ref: '#/components/schemas/WebhookEventName'
            - type: 'null'
          description: The event's type, or null when the stored event is gone.
        eventId:
          type: string
          description: >-
            The event's unique ID. A real event uses `evt_` and a UUID, a test
            send `evt_test_` and a UUID, and a sample from the sample operation
            `evt_sample_` and the event name. The same for every delivery, retry
            and resend of the event. Deduplicate on it, or on the `webhook-id`
            header, which carries the same value.
          examples:
            - evt_0198f2a4-7c1b-7d3e-9a52-3f6b1c2d4e5f
        id:
          type: string
          description: The delivery's unique ID.
          examples:
            - 0198f2a4-7c1b-7d3e-9a52-3f6b1c2d4e5f
        lastError:
          description: What went wrong at the last failed attempt, in a sentence.
          type:
            - string
            - 'null'
        nextAttemptAt:
          description: When the next attempt is due, while the delivery is pending.
          type:
            - string
            - 'null'
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
        outcome:
          description: >-
            The detail behind `status`, for example `delivered`,
            `retry_exhausted`, `gone` or `not_sendable`.
          type:
            - string
            - 'null'
        status:
          $ref: '#/components/schemas/WebhookDeliveryStatus'
      required:
        - attemptCount
        - attempts
        - completedAt
        - createdAt
        - endpointId
        - event
        - eventId
        - id
        - lastError
        - nextAttemptAt
        - outcome
        - status
      additionalProperties: false
      description: >-
        One event on its way to one endpoint, with every attempt made.
        Deliveries are listed for 30 days.
    ErrorWithFieldErrors:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
        fieldErrors:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            type: array
            items:
              type: string
        requestId:
          type: string
          description: >-
            Correlation identifier for support/debugging. Equals the
            `X-Lora-Request-Id` response header.
        traceId:
          description: >-
            Trace identifier when available for this request. 32-character
            lowercase hex string.
          type: string
          pattern: ^[0-9a-f]{32}$
      required:
        - error
        - requestId
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
        requestId:
          type: string
          description: >-
            Correlation identifier for support/debugging. Equals the
            `X-Lora-Request-Id` response header.
        traceId:
          description: >-
            Trace identifier when available for this request. 32-character
            lowercase hex string.
          type: string
          pattern: ^[0-9a-f]{32}$
      required:
        - error
        - requestId
      additionalProperties: false
    PaymentRequiredError:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
          enum:
            - plan_requires_upgrade
            - quota_exceeded
        requestId:
          type: string
          description: >-
            Correlation identifier for support/debugging. Equals the
            `X-Lora-Request-Id` response header.
        traceId:
          description: >-
            Trace identifier when available for this request. 32-character
            lowercase hex string.
          type: string
          pattern: ^[0-9a-f]{32}$
        current_plan:
          description: The workspace plan when the response includes it.
          type: string
        required_capability:
          description: The required plan capability when the response includes it.
          type: string
      required:
        - error
        - code
        - requestId
      additionalProperties: false
    ForbiddenError:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
        requestId:
          type: string
          description: >-
            Correlation identifier for support/debugging. Equals the
            `X-Lora-Request-Id` response header.
        traceId:
          description: >-
            Trace identifier when available for this request. 32-character
            lowercase hex string.
          type: string
          pattern: ^[0-9a-f]{32}$
        required_scope:
          description: >-
            Set when `code` is `insufficient_scope`. The exact scope name the
            route required, e.g. `shortcuts.write`.
          type: string
      required:
        - error
        - requestId
      additionalProperties: false
    PayloadTooLargeError:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
          const: payload_too_large
        requestId:
          type: string
          description: >-
            Correlation identifier for support/debugging. Equals the
            `X-Lora-Request-Id` response header.
        traceId:
          description: >-
            Trace identifier when available for this request. 32-character
            lowercase hex string.
          type: string
          pattern: ^[0-9a-f]{32}$
      required:
        - error
        - code
        - requestId
      additionalProperties: false
    InternalError:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
          const: internal_error
        requestId:
          type: string
          description: >-
            Correlation identifier for support/debugging. Equals the
            `X-Lora-Request-Id` response header.
        traceId:
          description: >-
            Trace identifier when available for this request. 32-character
            lowercase hex string.
          type: string
          pattern: ^[0-9a-f]{32}$
      required:
        - error
        - code
        - requestId
      additionalProperties: false
    WebhookEventName:
      type: string
      enum:
        - shortcut.created
        - shortcut.updated
        - shortcut.deleted
      description: >-
        An event type. `shortcut.created`: a visible shortcut was inserted, or a
        shortcut became visible to the workspace. `shortcut.updated`: a shortcut
        was updated. `shortcut.deleted`: a shortcut was removed, or left
        workspace visibility (made private or unlisted).
      examples:
        - shortcut.created
    WebhookAttempt:
      type: object
      properties:
        durationMs:
          description: How long the attempt took, in milliseconds.
          type:
            - integer
            - 'null'
          minimum: -9007199254740991
          maximum: 9007199254740991
        id:
          type: string
          description: The attempt's unique ID.
        number:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: 1 for the first attempt of the delivery, then counting up.
        outcome:
          type: string
          enum:
            - succeeded
            - failed
            - skipped
            - retry
            - crashed
          description: >-
            How the attempt ended: `succeeded`, `failed`, `skipped`, `retry` (it
            failed and another attempt was scheduled), or `crashed` (Lora lost
            the attempt before it recorded an outcome, and tries again).
          examples:
            - succeeded
        responseExcerpt:
          description: >-
            The first kilobyte of the receiver's answer, or null when there was
            none.
          type:
            - string
            - 'null'
        responseStatus:
          description: >-
            The HTTP status the receiver answered, or null when there was no
            answer.
          type:
            - integer
            - 'null'
          minimum: -9007199254740991
          maximum: 9007199254740991
        startedAt:
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
          description: ISO 8601 start time.
        trigger:
          type: string
          enum:
            - scheduled
            - manual
          description: >-
            `scheduled`: the first attempt, a retry, or a test send. `manual`: a
            resend.
      required:
        - durationMs
        - id
        - number
        - outcome
        - responseExcerpt
        - responseStatus
        - startedAt
        - trigger
      additionalProperties: false
      description: One try to deliver an event.
    WebhookDeliveryStatus:
      type: string
      enum:
        - pending
        - succeeded
        - failed
        - skipped
        - canceled
        - expired
        - quarantined
      description: >-
        `pending`: waiting for an attempt or a retry. `succeeded`: the receiver
        answered 2xx. `failed`: ended without success, because retries ran out
        or the failure cannot be retried. `skipped`: not sent, because the
        shortcut is private, unlisted or deleted by now, the endpoint is off, or
        the plan no longer includes webhooks. `canceled`: the endpoint's URL
        changed, an event type was removed from it, or it was turned off or
        deleted. `quarantined`: Lora stopped processing the delivery after
        repeated internal errors. `expired`: reserved; webhook endpoints do not
        use it today.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Workspace API key (`lora_sk_…`) sent as `Authorization: Bearer
        <api_key>`. Each scoped operation names the scope it requires in its
        `security` requirement, for example `shortcuts.write`; a key without it
        receives `403` with `code: insufficient_scope`. `GET /v1/qr` also
        accepts anonymous requests and requires no scope.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.