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

# List Webhook Endpoints

> List webhook endpoints in an environment.



## OpenAPI

````yaml POST /webhook-endpoints/list
openapi: 3.1.0
info:
  title: Knot API
  description: An API to interact with the Knot merchant connectivity platform.
  version: 1.0.0
servers:
  - url: https://development.knotapi.com
    description: Development server
security:
  - basicAuth: []
paths:
  /webhook-endpoints/list:
    servers:
      - url: https://api.dashboard.knotapi.com
    post:
      summary: List Webhook Endpoints
      description: List webhook endpoints in an environment.
      operationId: webhook_endpoints_list
      requestBody:
        description: The input parameters required for listing webhook endpoints.
        content:
          application/json:
            schema:
              type: object
              properties:
                environment:
                  type: string
                  description: >-
                    The environment the webhook endpoint belongs to. Must match
                    your access token's environment.
                  enum:
                    - development
                    - production
                  example: development
              required:
                - environment
            examples:
              ListWebhookEndpoints:
                summary: List webhook endpoints
                value:
                  environment: development
      responses:
        '200':
          description: Successful request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhook_endpoints:
                    type: array
                    description: Webhook endpoints, newest first.
                    items:
                      $ref: '#/components/schemas/WebhookEndpoint'
              examples:
                WebhookEndpoints:
                  summary: Webhook endpoints
                  value:
                    webhook_endpoints:
                      - id: 0a8f5c6e-3d2b-4e1a-9f7c-8b6d5e4c3a21
                        url: https://example.com/webhooks/knot
                        description: Primary webhook listener
                        environment: development
                        created_at: '2026-10-01T14:32:08Z'
                      - id: 5b7e2d14-9c3a-4f8e-b6d1-2a4c6e8f0b13
                        url: https://staging.example.com/webhooks/knot
                        description: null
                        environment: development
                        created_at: '2026-09-15T09:12:44Z'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                EnvironmentRequired:
                  summary: environment is required
                  value:
                    error_type: INVALID_REQUEST
                    error_code: INVALID_FIELD
                    error_message: The environment field is required.
                EnvironmentInvalid:
                  summary: environment is invalid
                  value:
                    error_type: INVALID_REQUEST
                    error_code: INVALID_FIELD
                    error_message: The selected environment is invalid.
        '401':
          description: Unauthorized request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                InvalidAccessToken:
                  summary: Invalid or expired access token
                  value:
                    error_type: INVALID_INPUT
                    error_code: INVALID_ACCESS_TOKEN
                    error_message: >-
                      The access token is invalid or has expired. Request a new
                      access token.
        '403':
          description: Forbidden request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                InsufficientScope:
                  summary: Missing scope
                  value:
                    error_type: INVALID_REQUEST
                    error_code: INSUFFICIENT_SCOPE
                    error_message: The access token does not include the webhooks:read scope.
                EnvironmentMismatch:
                  summary: Access token is for another environment
                  value:
                    error_type: INVALID_REQUEST
                    error_code: ENVIRONMENT_MISMATCH
                    error_message: >-
                      This access token can only manage development webhook
                      endpoints. Request a new access token with your production
                      client_id.
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                RateLimitExceeded:
                  summary: Rate limit exceeded
                  value:
                    error_type: INVALID_REQUEST
                    error_code: RATE_LIMIT_EXCEEDED
                    error_message: Too many requests. Retry after 30 seconds.
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                InternalServerError:
                  summary: Unexpected server error
                  value:
                    message: Server Error
      security:
        - agentAccessToken:
            - webhooks:read
components:
  schemas:
    WebhookEndpoint:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the webhook endpoint.
          example: 0a8f5c6e-3d2b-4e1a-9f7c-8b6d5e4c3a21
        url:
          type: string
          description: The URL Knot sends webhooks to.
          example: https://example.com/webhooks/knot
        description:
          type:
            - string
            - 'null'
          description: A description of the webhook endpoint, or `null` if none.
          example: Primary webhook listener
        environment:
          type: string
          description: The environment the webhook endpoint belongs to.
          enum:
            - development
            - production
          example: development
        created_at:
          type: string
          format: date-time
          description: When the webhook endpoint was created, in ISO 8601 format.
          example: '2026-10-01T14:32:08Z'
    Error:
      type: object
      properties:
        error_type:
          type: string
          description: Type of error.
          enum:
            - INVALID_INPUT
            - INVALID_REQUEST
            - USER_ERROR
            - SESSION_ERROR
            - MERCHANT_ACCOUNT_ERROR
            - MERCHANT_ERROR
            - SUBSCRIPTION_ERROR
            - TRANSACTION_ERROR
            - CART_ERROR
            - WEBHOOK_ENDPOINT_ERROR
          example: INVALID_REQUEST
        error_code:
          type: string
          description: Error code.
          enum:
            - INVALID_API_KEYS
            - INVALID_FIELD
            - INVALID_JWE
            - INVALID_CURSOR_FORMAT
            - USER_NOT_FOUND
            - MERCHANT_ACCOUNT_NOT_FOUND
            - MERCHANT_ACCOUNT_DISCONNECTED
            - SESSION_NOT_FOUND
            - EXTEND_NOT_SUPPORTED
            - MERCHANT_UNAVAILABLE
            - NO_ACCESS
            - TRANSACTION_NOT_FOUND
            - NO_TRANSACTIONS
            - SUBSCRIPTION_NOT_FOUND
            - CANCELLABLE_SUBSCRIPTION_NOT_FOUND
            - MULTIPLE_CANCELLABLE_SUBSCRIPTIONS_FOUND
            - ONGOING_OPERATION
            - CART_NOT_FOUND
            - FULFILLMENT_NOT_FOUND
            - INVALID_ACCESS_TOKEN
            - INSUFFICIENT_SCOPE
            - INSUFFICIENT_ROLE
            - WEBHOOK_ENDPOINT_NOT_FOUND
            - WEBHOOK_ENDPOINT_LIMIT_REACHED
            - WEBHOOK_ENDPOINT_ALREADY_EXISTS
            - RATE_LIMIT_EXCEEDED
            - ENVIRONMENT_MISMATCH
          example: INVALID_FIELD
        error_message:
          type: string
          description: Detailed error message.
          example: The limit may not be greater than 10.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: >-
        Basic authentication header of the form `Basic <encoded-value>`, where
        `<encoded-value>` is the base64-encoded string `username:password`. Use
        your `client_id` as the `username` and your `secret` as the `password`
        value.
    agentAccessToken:
      type: http
      scheme: bearer
      description: >-
        Short-lived access token from the [device authorization
        flow](/api-reference/agent-authorization/overview). Expires after 15
        minutes. Manages only the environment of the client ID it was issued
        for.

````

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