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

# Listar webhooks padrão

> Liste os webhooks padrão do workspace

## Conceituação

Retorna os webhooks padrão do workspace da secret key, habilitados e desabilitados. Webhooks de canal e [webhooks de template](/webhooks/template-webhooks.md) não aparecem nesta lista.

O campo `auth.configured` indica se há credencial de autenticação configurada, mas a credencial em si **não é retornada**. O `secret` da assinatura HMAC também não é retornado: ele só aparece na resposta que o gerou.


## OpenAPI

````yaml pt/webhooks/openapi-default.json GET /v1/default-instance-webhooks
openapi: 3.1.0
info:
  title: Omni Z-API - Webhook padrão do workspace
  description: >-
    API para criar e gerenciar o webhook padrão do workspace: um webhook sem
    canal que recebe os eventos de todo canal do workspace que não tem webhook
    próprio ativo. Aceita os eventos de canal, nos formatos `DEFAULT` e `Z_API`,
    com até 5 por workspace. Não exige a role ENTERPRISE: basta uma secret key
    válida de um workspace ativo.
  version: 1.0.0
servers:
  - url: https://api.omni.z-api.io
security:
  - bearerAuth: []
paths:
  /v1/default-instance-webhooks:
    get:
      tags:
        - Webhook padrão
      summary: Listar webhooks padrão
      description: >-
        Retorna os webhooks padrão do workspace, habilitados e desabilitados.
        Webhooks de canal e de template não aparecem aqui. As credenciais de
        autenticação e o `secret` não são retornados.
      operationId: listDefaultInstanceWebhooks
      responses:
        '200':
          description: Webhooks padrão do workspace
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DefaultWebhookResponse'
              example:
                - id: 5B7E3A90C2D14F6A8E1B2C3D4E5F6A7B
                  channelId: null
                  instanceId: null
                  url: https://app.suaempresa.com/webhooks/omni-zapi
                  description: Eventos de todos os canais
                  events:
                    - MESSAGE_RECEIVED
                    - MESSAGE_STATUS
                    - DISCONNECTED
                  status: ENABLED
                  signing: false
                  auth:
                    type: NONE
                    configured: false
                  payloadFormat: DEFAULT
                  customAttributes: {}
                  createdAt: '2026-10-22T15:00:00.000+00:00'
                  updatedAt: '2026-10-22T15:00:00.000+00:00'
        '400':
          description: Secret key ausente ou inválida, ou IP fora da lista do workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                invalidKey:
                  summary: Secret key ausente ou inválida
                  value:
                    error: Authorization invalid
                ipNotAllowed:
                  summary: IP fora da lista de IPs permitidos do workspace
                  value:
                    error: 203.0.113.10 not allowed
        '422':
          description: Workspace excluído ou inexistente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Webhook management requires an active workspace
components:
  schemas:
    DefaultWebhookResponse:
      type: object
      properties:
        id:
          type: string
          description: ID do webhook padrão
          example: 5B7E3A90C2D14F6A8E1B2C3D4E5F6A7B
        channelId:
          type:
            - string
            - 'null'
          description: 'Sempre `null`: o webhook padrão não pertence a um canal'
          example: null
        instanceId:
          type:
            - string
            - 'null'
          description: Sempre `null`. Campo legado, mantido por compatibilidade
          deprecated: true
          example: null
        url:
          type: string
          example: https://app.suaempresa.com/webhooks/omni-zapi
        description:
          type:
            - string
            - 'null'
          example: Eventos de todos os canais
        events:
          type: array
          items:
            type: string
            enum:
              - MESSAGE_RECEIVED
              - MESSAGE_DELIVERY
              - MESSAGE_STATUS
              - RECEIVED_STATUS
              - RECEIVED_AND_DELIVERY
              - CONNECTED
              - DISCONNECTED
              - PRESENCE_CHAT
              - INITIAL_DATA
              - BLOCK
        status:
          type: string
          enum:
            - ENABLED
            - DISABLED
          description: '`ENABLED` ou `DISABLED`'
        signing:
          type: boolean
          description: '`true` quando a assinatura HMAC está ligada'
        auth:
          $ref: '#/components/schemas/WebhookAuthInfo'
        payloadFormat:
          type: string
          enum:
            - DEFAULT
            - Z_API
        customAttributes:
          type: object
          additionalProperties: true
        createdAt:
          type: string
          format: date-time
          description: Data de criação
        updatedAt:
          type: string
          format: date-time
          description: Data da última alteração
    Error:
      type: object
      description: Erro
      properties:
        error:
          type: string
          description: Mensagem do erro
    WebhookAuthInfo:
      type: object
      description: Resumo da autenticação configurada. As credenciais não são retornadas.
      properties:
        type:
          type: string
          enum:
            - NONE
            - BEARER
            - API_KEY
            - BASIC
            - CUSTOM_HEADER
          example: NONE
        configured:
          type: boolean
          description: '`true` quando há credencial configurada'
          example: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Secret Key gerada no painel de Segurança do Omni Z-API

````

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