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

# Listar webhooks

> Lista webhooks configurados no workspace. Filtre por evento e pagine resultados.



## OpenAPI

````yaml /es/guides/webhooks/api-reference/openapi-webhooks.json get /v1/webhooks
openapi: 3.0.3
info:
  title: Notifique API. Webhooks
  description: >-
    Cadastre URLs HTTPS para receber eventos da Notifique em tempo real.
    Autentique com `Authorization: Bearer sk_live_...` ou `x-api-key`. Escopos:
    `webhooks:read`, `webhooks:manage`.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Produção
security:
  - ntfWhBearerAuth: []
  - ntfWhApiKeyHeader: []
tags:
  - name: Webhooks
    description: CRUD de endpoints de webhook do workspace.
  - name: Entregas
    description: Histórico e reenvio de tentativas de entrega de webhook.
paths:
  /v1/webhooks:
    get:
      tags:
        - Webhooks
      summary: Listar webhooks
      description: >-
        Lista webhooks configurados no workspace. Filtre por evento e pagine
        resultados.
      operationId: ntfWh_listWebhooks
      parameters:
        - name: page
          in: query
          schema:
            type: integer
          description: Página (padrão 1).
        - name: limit
          in: query
          schema:
            type: integer
          description: Itens por página (máx. 100).
        - name: event
          in: query
          schema:
            type: string
          description: 'Filtra por nome de evento (ex.: `message.sent`).'
      responses:
        '200':
          description: Lista paginada de webhooks.
          content:
            application/json:
              example:
                success: true
                data:
                  - id: clwh_01HABC...
                    name: Meu webhook
                    url: https://api.seudominio.com/receive
                    events:
                      - message.sent
                      - message.delivered
                    instanceIds: []
                    enabled: true
                    createdAt: '2026-08-01T10:00:00.000Z'
                    updatedAt: '2026-08-10T12:00:00.000Z'
                pagination:
                  total: 1
                  page: 1
                  limit: 20
                  totalPages: 1
              schema:
                $ref: '#/components/schemas/ntfWh_ListWebhooksResponse'
        '401':
          $ref: '#/components/responses/Ntf_Unauthorized'
        '403':
          $ref: '#/components/responses/Ntf_Forbidden'
components:
  schemas:
    ntfWh_ListWebhooksResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              url:
                type: string
              events:
                type: array
                items:
                  type: string
              instanceIds:
                type: array
                items:
                  type: object
              enabled:
                type: boolean
              createdAt:
                type: string
              updatedAt:
                type: string
        pagination:
          type: object
          properties:
            total:
              type: integer
            page:
              type: integer
            limit:
              type: integer
            totalPages:
              type: integer
      example:
        success: true
        data:
          - id: clxx...
            name: Exemplo
            url: https://example.com/resource
            events:
              - string
            instanceIds:
              - {}
            enabled: true
            createdAt: string
            updatedAt: string
        pagination:
          total: 1
          page: 1
          limit: 1
          totalPages: 1
    Ntf_Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
        message:
          type: string
        code:
          type: string
      example:
        success: false
        error: string
        message: string
        code: string
  responses:
    Ntf_Unauthorized:
      description: Chave ausente, inválida ou revogada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Ntf_Error'
          example:
            success: false
            error: Unauthorized
            message: Invalid API key
            code: UNAUTHORIZED
    Ntf_Forbidden:
      description: Escopo ausente ou recurso fora da permissão da chave.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Ntf_Error'
          example:
            success: false
            error: Forbidden
            message: Missing scope webhooks:manage
            code: FORBIDDEN
  securitySchemes:
    ntfWhBearerAuth:
      type: http
      scheme: bearer
      description: API key `sk_live_...` ou `sk_test_...`.
    ntfWhApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: Alternativa ao Bearer.

````