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

# List webhooks

> Lists the webhooks configured on the instance.



## OpenAPI

````yaml /en/api-reference/openapi.json get /instances/{id}/webhooks
openapi: 3.1.0
info:
  title: Zapfy API
  description: >-
    Multi-tenant WhatsApp API. Send messages and manage webhooks through a
    single surface.
  version: 1.0.0
servers:
  - url: https://api.zapfy.io/v1
security:
  - accountToken: []
paths:
  /instances/{id}/webhooks:
    parameters:
      - $ref: '#/components/parameters/InstanceId'
    get:
      tags:
        - Webhooks
      summary: List webhooks
      description: Lists the webhooks configured on the instance.
      responses:
        '200':
          description: Instance webhooks.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Webhook'
        '401':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
components:
  parameters:
    InstanceId:
      name: id
      in: path
      required: true
      description: Instance ID.
      schema:
        type: string
  schemas:
    Webhook:
      type: object
      properties:
        id:
          type: string
          example: 01J9Z...
          description: Webhook identifier.
        url:
          type: string
          example: https://your-app.com/webhooks
          description: HTTPS URL that receives the events.
        events:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEvent'
          description: Events subscribed by this webhook.
        enabled:
          type: boolean
          example: true
          description: Whether the webhook is active.
        createdAt:
          type: string
          format: date-time
          description: Creation date (ISO 8601).
    WebhookEvent:
      type: string
      enum:
        - MESSAGE_RECEIVED
        - MESSAGE_SENT
        - MESSAGE_STATUS
        - CONNECTION_UPDATE
        - QRCODE_UPDATED
      description: >-
        Event type. `MESSAGE_RECEIVED` = incoming message; `MESSAGE_SENT` =
        message sent by the instance; `MESSAGE_STATUS` = delivery/read status
        change; `CONNECTION_UPDATE` = instance connection change;
        `QRCODE_UPDATED` = new QR Code to pair.
  responses:
    Error:
      description: Error.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: Instance not found
  securitySchemes:
    accountToken:
      type: http
      scheme: bearer
      description: Account token (`zpfy_acct_...`) — manages instances and webhooks.

````