> ## 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 predeterminados

> Lista los webhooks predeterminados del workspace

## Conceptos

Devuelve los webhooks predeterminados del workspace de la secret key, habilitados y deshabilitados. Los webhooks de canal y los [webhooks de plantilla](/es/webhooks/template-webhooks.md) no aparecen en esta lista.

El campo `auth.configured` indica si hay una credencial de autenticación configurada, pero la credencial en sí **no se devuelve**. El `secret` de la firma HMAC tampoco se devuelve: solo aparece en la respuesta que lo generó.


## OpenAPI

````yaml es/webhooks/openapi-default.json GET /v1/default-instance-webhooks
openapi: 3.1.0
info:
  title: Omni Z-API - Webhook predeterminado del workspace
  description: >-
    API para crear y gestionar el webhook predeterminado del workspace: un
    webhook sin canal que recibe los eventos de todo canal del workspace que no
    tiene un webhook propio activo. Admite los eventos de canal, en los formatos
    `DEFAULT` y `Z_API`, con hasta 5 por workspace. No requiere el rol
    ENTERPRISE: basta con una secret key válida de un workspace activo.
  version: 1.0.0
servers:
  - url: https://api.omni.z-api.io
security:
  - bearerAuth: []
paths:
  /v1/default-instance-webhooks:
    get:
      tags:
        - Webhook predeterminado
      summary: Listar webhooks predeterminados
      description: >-
        Devuelve los webhooks predeterminados del workspace, habilitados y
        deshabilitados. Los webhooks de canal y de plantilla no aparecen aquí.
        Las credenciales de autenticación y el `secret` no se devuelven.
      operationId: listDefaultInstanceWebhooks
      responses:
        '200':
          description: Webhooks predeterminados del workspace
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DefaultWebhookResponse'
              example:
                - id: 5B7E3A90C2D14F6A8E1B2C3D4E5F6A7B
                  channelId: null
                  instanceId: null
                  url: https://app.suempresa.com/webhooks/omni-zapi
                  description: Eventos de todos los canales
                  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 o inválida, o IP fuera de la lista del workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                invalidKey:
                  summary: Secret key ausente o inválida
                  value:
                    error: Authorization invalid
                ipNotAllowed:
                  summary: IP fuera de la lista de IP permitidas del workspace
                  value:
                    error: 203.0.113.10 not allowed
        '422':
          description: Workspace eliminado o 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 del webhook predeterminado
          example: 5B7E3A90C2D14F6A8E1B2C3D4E5F6A7B
        channelId:
          type:
            - string
            - 'null'
          description: 'Siempre `null`: el webhook predeterminado no pertenece a un canal'
          example: null
        instanceId:
          type:
            - string
            - 'null'
          description: Siempre `null`. Campo heredado, mantenido por compatibilidad
          deprecated: true
          example: null
        url:
          type: string
          example: https://app.suempresa.com/webhooks/omni-zapi
        description:
          type:
            - string
            - 'null'
          example: Eventos de todos los canales
        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` o `DISABLED`'
        signing:
          type: boolean
          description: '`true` cuando la firma HMAC está activa'
        auth:
          $ref: '#/components/schemas/WebhookAuthInfo'
        payloadFormat:
          type: string
          enum:
            - DEFAULT
            - Z_API
        customAttributes:
          type: object
          additionalProperties: true
        createdAt:
          type: string
          format: date-time
          description: Fecha de creación
        updatedAt:
          type: string
          format: date-time
          description: Fecha de la última modificación
    Error:
      type: object
      description: Error
      properties:
        error:
          type: string
          description: Mensaje del error
    WebhookAuthInfo:
      type: object
      description: >-
        Resumen de la autenticación configurada. Las credenciales no se
        devuelven.
      properties:
        type:
          type: string
          enum:
            - NONE
            - BEARER
            - API_KEY
            - BASIC
            - CUSTOM_HEADER
          example: NONE
        configured:
          type: boolean
          description: '`true` cuando hay una credencial configurada'
          example: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Secret Key generada en el panel de Seguridad de Omni Z-API

````

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