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

# List webhook endpoints

> Returns the workspace's webhook endpoints, oldest first: its own, and the subscriptions that integrations such as Zapier made, which are marked `source: subscription`. Signing secrets are never part of the response. Reading needs API access (Basic and above), not the Business plan, so a workspace that dropped from Business to Basic can still see its endpoints.



## OpenAPI

````yaml /openapi.json get /v1/webhooks
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:
    get:
      tags:
        - Webhooks
      summary: List webhook endpoints
      description: >-
        Returns the workspace's webhook endpoints, oldest first: its own, and
        the subscriptions that integrations such as Zapier made, which are
        marked `source: subscription`. Signing secrets are never part of the
        response. Reading needs API access (Basic and above), not the Business
        plan, so a workspace that dropped from Business to Basic can still see
        its endpoints.
      operationId: listWebhookEndpoints
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWebhookEndpointsResponse'
          description: All webhook endpoints of the workspace.
        '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':
          description: >-
            The workspace plan does not include API access, the requested
            capability, or enough resource capacity. The body uses
            `plan_requires_upgrade` or `quota_exceeded`. Upgrade the workspace
            or change the request; retrying the same request will not 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/PaymentRequiredError'
        '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
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Rate limit exceeded. 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.read
components:
  schemas:
    ListWebhookEndpointsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEndpoint'
      required:
        - items
      additionalProperties: false
      description: >-
        All webhook endpoints of the workspace, oldest first. A workspace has at
        most ten of its own, so the list is not paginated.
    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
    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
    WebhookEndpoint:
      type: object
      properties:
        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: ISO 8601 creation time.
        description:
          description: The endpoint's label, or null when it has none.
          type:
            - string
            - 'null'
        disabledReason:
          description: >-
            Why the endpoint is off, or null while it is on. `manual`: someone
            turned it off. `gone`: the receiver answered 410 Gone. `failing`:
            for five days no delivery succeeded, and at least five deliveries
            ran out of retries.
          type:
            - string
            - 'null'
          enum:
            - manual
            - gone
            - failing
            - null
        enabled:
          type: boolean
          description: >-
            Whether events are delivered. Turning an endpoint off cancels the
            deliveries still waiting for it.
        events:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEventName'
          description: The events the endpoint receives.
        id:
          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
        previousSecretExpiresAt:
          description: >-
            While a rotated secret still signs next to the new one, when it
            stops, ISO 8601; otherwise null.
          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))$
        source:
          type: string
          enum:
            - api
            - subscription
          description: >-
            `api`: created with an API key. `subscription`: made by an
            integration such as Zapier, which owns it. You can read it here;
            only the integration changes or deletes it.
        updatedAt:
          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 time of the last change.
        url:
          type: string
          description: >-
            The URL that receives events. For an endpoint an integration made
            (`source: subscription`), only the host is shown.
      required:
        - createdAt
        - description
        - disabledReason
        - enabled
        - events
        - id
        - previousSecretExpiresAt
        - source
        - updatedAt
        - url
      additionalProperties: false
      description: >-
        A webhook endpoint. Its signing secret is never part of it: it is
        returned once, when the endpoint is created or its secret rotated.
    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
  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.