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

# Actualizar webhook predeterminado

> Actualiza la configuración de un webhook predeterminado existente

## Conceptos

Actualiza parcialmente un webhook predeterminado. Solo se actualizan los campos enviados en el body; los demás se mantienen como están.

### Actualizar los eventos

Si envías el campo `events`, la lista sustituye los eventos existentes y debe contener solo eventos de canal (un evento de plantilla devuelve `422`). Una lista vacía devuelve `400`: para mantener los eventos, omite el campo.

```json theme={null}
{ "events": ["MESSAGE_RECEIVED", "CONNECTED", "DISCONNECTED"] }
```

### Deshabilitar temporalmente

```json theme={null}
{ "status": "DISABLED" }
```

Para volver a habilitarlo, envía `{ "status": "ENABLED" }`. El webhook deshabilitado sigue contando en el límite de 5 del workspace.

### Formato

`payloadFormat` admite `DEFAULT` y `Z_API`. `CHATWOOT` devuelve `422`.

### Firma HMAC

`signing: true` genera un `secret` nuevo, devuelto solo en esta respuesta; `signing: false` desactiva la firma. Sin `signing: true`, la respuesta trae `secret: null` y el secreto guardado no cambia.

> [!WARNING]
>
> `signing: true` genera un `secret` nuevo **cada vez**, aunque la firma ya estuviera activa y solo quisieras cambiar otro campo. Para mantener el secreto actual, **omite** el campo `signing`.

Para validar la firma, consulta [Firma HMAC](/es/webhooks/signature.md).

> [!NOTE]
>
> La URL solo se comprueba cuando cambia. Una URL nueva sigue las mismas reglas de la creación: absoluta, `http` o `https`, de hasta 2048 caracteres, con un host que resuelve solo a direcciones públicas.


## OpenAPI

````yaml es/webhooks/openapi-default.json PATCH /v1/default-instance-webhooks/{webhookId}
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/{webhookId}:
    parameters:
      - name: webhookId
        in: path
        required: true
        description: ID del webhook predeterminado
        schema:
          type: string
          example: 5B7E3A90C2D14F6A8E1B2C3D4E5F6A7B
    patch:
      tags:
        - Webhook predeterminado
      summary: Actualizar webhook predeterminado
      description: >-
        Actualiza parcialmente un webhook predeterminado: el campo omitido no
        cambia. `events` sustituye la lista entera. `status: "DISABLED"` pausa
        el webhook sin eliminarlo. `signing: true` genera un `secret` nuevo,
        devuelto solo en esta respuesta.
      operationId: updateDefaultInstanceWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDefaultWebhookRequest'
            examples:
              disable:
                summary: Deshabilitar
                value:
                  status: DISABLED
              replaceEvents:
                summary: Cambiar los eventos
                value:
                  events:
                    - MESSAGE_RECEIVED
                    - CONNECTED
                    - DISCONNECTED
              rotateSecret:
                summary: Generar un secret nuevo
                value:
                  signing: true
      responses:
        '200':
          description: >-
            Webhook predeterminado actualizado. El `secret` viene como `null`,
            salvo cuando la petición trae `signing: true`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultWebhookCreatedResponse'
              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: DISABLED
                signing: false
                secret: null
                auth:
                  type: NONE
                  configured: false
                payloadFormat: DEFAULT
                customAttributes: {}
                createdAt: '2026-10-22T15:00:00.000+00:00'
                updatedAt: '2026-10-22T15:30:00.000+00:00'
        '400':
          description: >-
            Cuerpo inválido, URL nueva rechazada o secret key inválida. No se
            guarda nada.
          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
                emptyEvents:
                  summary: '`events` enviado como lista vacía'
                  value:
                    error: Events cannot be empty when provided
                unknownEvent:
                  summary: Nombre de evento desconocido, nulo o en blanco
                  value:
                    error: events contains an unknown or empty event name
                invalidStatus:
                  summary: '`status` distinto de `ENABLED` y `DISABLED`'
                  value:
                    error: status must be one of [ENABLED, DISABLED]
                invalidUrl:
                  summary: URL con formato inválido
                  value:
                    error: >-
                      Invalid webhook URL: use an absolute http or https URL up
                      to 2048 characters
                urlNotAllowed:
                  summary: El host de la URL resuelve a una dirección no pública
                  value:
                    error: >-
                      Webhook URL not allowed: the host must resolve only to
                      public addresses
                missingCredentials:
                  summary: Tipo de autenticación sin su credencial
                  value:
                    error: Credentials are required when auth type is not NONE
        '404':
          description: >-
            No hay un webhook predeterminado con ese id en el workspace. Un id
            de otro workspace, de un webhook de canal o de un webhook de
            plantilla recibe la misma respuesta.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Webhook not found
        '422':
          description: >-
            Evento que no es de canal, formato `CHATWOOT` o workspace inactivo.
            No se guarda nada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                templateEvent:
                  summary: Evento de plantilla (u otro evento que no es de canal)
                  value:
                    error: >-
                      Default instance webhooks cannot subscribe to template
                      events
                chatwoot:
                  summary: Formato `CHATWOOT`
                  value:
                    error: >-
                      Default instance webhooks do not support CHATWOOT payload
                      format: configure Chatwoot on the channel
                inactiveWorkspace:
                  summary: Workspace eliminado o inexistente
                  value:
                    error: Webhook management requires an active workspace
        '503':
          description: >-
            No fue posible comprobar el destino de la URL en este momento.
            Inténtalo de nuevo.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Could not verify the webhook URL now, try again
components:
  schemas:
    UpdateDefaultWebhookRequest:
      type: object
      description: 'Todos los campos son opcionales: solo se actualizan los campos enviados.'
      properties:
        url:
          type: string
          description: >-
            Nueva URL de destino. Solo se comprueba la URL distinta de la
            guardada.
          example: https://nova-url.suempresa.com/webhooks/omni-zapi
        description:
          type: string
          description: Descripción opcional del webhook
          example: Eventos de todos los canales
        events:
          type: array
          description: >-
            Nueva lista de eventos de canal. Sustituye la lista entera. Para
            mantener los eventos, omite el campo.
          items:
            type: string
            enum:
              - MESSAGE_RECEIVED
              - MESSAGE_DELIVERY
              - MESSAGE_STATUS
              - RECEIVED_STATUS
              - RECEIVED_AND_DELIVERY
              - CONNECTED
              - DISCONNECTED
              - PRESENCE_CHAT
              - INITIAL_DATA
              - BLOCK
          example:
            - MESSAGE_RECEIVED
            - MESSAGE_STATUS
            - DISCONNECTED
        status:
          type: string
          enum:
            - ENABLED
            - DISABLED
          description: >-
            `DISABLED` pausa el webhook sin eliminarlo; `ENABLED` lo vuelve a
            habilitar
        signing:
          type: boolean
          description: >-
            `true` genera un `secret` nuevo (devuelto solo en esta respuesta),
            aunque la firma ya estuviera activa. `false` desactiva la firma.
            Omítelo para no cambiarla.
        authType:
          type: string
          enum:
            - NONE
            - BEARER
            - API_KEY
            - BASIC
            - CUSTOM_HEADER
          description: Tipo de autenticación (forma plana). Alternativa al objeto `auth`.
        token:
          type: string
          description: Credencial para `BEARER` (forma plana)
        key:
          type: string
          description: Credencial para `API_KEY` (forma plana)
        auth:
          $ref: '#/components/schemas/WebhookAuth'
        payloadFormat:
          type: string
          enum:
            - DEFAULT
            - Z_API
          description: >-
            `DEFAULT` o `Z_API`. `CHATWOOT` se rechaza con `422`. Omítelo para
            no cambiarlo.
        customAttributes:
          type: object
          description: Mapa libre de atributos extra
          additionalProperties: true
    DefaultWebhookCreatedResponse:
      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'
        secret:
          type:
            - string
            - 'null'
          description: >-
            Secreto de la firma HMAC. Viene relleno solo en la respuesta que lo
            generó (`signing: true`); en las demás, `null`.
        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
    WebhookAuth:
      type: object
      description: Cómo se autentica Omni Z-API al llamar a tu URL
      properties:
        type:
          type: string
          enum:
            - NONE
            - BEARER
            - API_KEY
            - BASIC
            - CUSTOM_HEADER
          description: Tipo de autenticación
          example: BEARER
        token:
          type: string
          description: >-
            Token para `BEARER`, enviado en el header `Authorization: Bearer
            <token>`
        key:
          type: string
          description: Clave para `API_KEY`
        username:
          type: string
          description: Usuario para `BASIC`
        password:
          type: string
          description: Contraseña para `BASIC`
        headerName:
          type: string
          description: Nombre del header para `CUSTOM_HEADER`
          example: X-Api-Key
        headerValue:
          type: string
          description: Valor del header para `CUSTOM_HEADER`
    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.