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

# List webhooks



## OpenAPI

````yaml /api-reference/support-openapi.json get /api/webhooks/list
openapi: 3.1.0
info:
  title: Clarity Support API
  version: '1.0'
  description: Tickets, customers, messages, the knowledge base, and webhooks.
servers:
  - url: https://back.leap.onclarity.com
security:
  - organizationApiKey: []
tags:
  - name: AI service
    description: >-
      Hand a customer conversation to your Clarity AI agent from your own app or
      backend.
  - name: Messages
    description: Reply to customers on their ticket's channel and add private notes.
  - name: Customers
    description: Create, update, and look up customers and their custom attributes.
  - name: Tickets
    description: >-
      Change a ticket's status, assignee, category, and tags, and list the
      values they take.
  - name: Knowledge base
    description: Manage the articles your AI agents answer from.
  - name: Webhooks
    description: Subscribe your endpoints to events in your organization.
paths:
  /api/webhooks/list:
    get:
      tags:
        - Webhooks
      summary: List webhooks
      operationId: ApiWebhooksListListWebhooks
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            default: 20
          required: false
          deprecated: false
          allowEmptyValue: false
          allowReserved: false
        - name: offset
          in: query
          schema:
            type: integer
            default: 0
          required: false
          deprecated: false
          allowEmptyValue: false
          allowReserved: false
        - name: search
          in: query
          schema:
            oneOf:
              - type: string
              - type: 'null'
          required: false
          deprecated: false
          allowEmptyValue: false
          allowReserved: false
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhooks_schema_WebhookListResponse'
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KTSErrorResponse'
        '500':
          description: Server got itself in trouble
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KTSErrorResponse'
      deprecated: false
components:
  schemas:
    webhooks_schema_WebhookListResponse:
      properties:
        list:
          items:
            $ref: '#/components/schemas/Webhook'
          type: array
        total:
          type: integer
      type: object
      required:
        - list
        - total
      title: WebhookListResponse
    KTSErrorResponse:
      properties:
        status:
          type: string
          default: error
        code:
          type: string
        message:
          oneOf:
            - type: string
            - type: 'null'
        extra:
          oneOf:
            - additionalProperties: {}
              type: object
            - items: {}
              type: array
            - type: 'null'
      type: object
      required:
        - code
      title: KTSErrorResponse
    Webhook:
      properties:
        id:
          type: integer
        organization_id:
          type: integer
        endpoint:
          type: string
        status:
          $ref: '#/components/schemas/WebhookStatus'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        events:
          items:
            $ref: '#/components/schemas/WebhookEvent'
          type: array
      type: object
      required:
        - created_at
        - endpoint
        - id
        - organization_id
        - status
        - updated_at
      title: Webhook
    WebhookStatus:
      type: string
      enum:
        - active
        - disabled
      title: WebhookStatus
      default: active
    WebhookEvent:
      properties:
        id:
          type: integer
        key:
          $ref: '#/components/schemas/WebhookEventKey'
        display_name:
          type: string
        specs:
          oneOf:
            - {}
            - type: 'null'
      type: object
      required:
        - display_name
        - id
        - key
      title: WebhookEvent
    WebhookEventKey:
      type: string
      enum:
        - message
        - private_note
        - status_change
        - assignee_change
        - team_change
        - priority_change
        - snoozed
        - snooze_end
        - ticket_closed
        - category_change
        - embedded_form_submitted
        - ticket_tags_changed
        - survey_sent
        - wa_template_message
        - prompt
        - recommendation
        - system_notification
        - ticket_created
        - voice_call_ended
        - voice_call_warning
        - kb_article_created
        - incident_detected
        - incident_updated
        - incident_resolved
      title: WebhookEventKey
  securitySchemes:
    organizationApiKey:
      type: http
      scheme: bearer
      description: >-
        Your organization API key (it starts with `anek_org_`). The same key
        works on the Voice API and the Support API. See
        [Authentication](/authentication).

````

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