curl --request PATCH \
--url https://api.omni.z-api.io/v1/default-instance-webhooks/{webhookId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "DISABLED"
}
'{
"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"
}Actualizar webhook predeterminado
Actualiza la configuración de un webhook predeterminado existente
curl --request PATCH \
--url https://api.omni.z-api.io/v1/default-instance-webhooks/{webhookId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "DISABLED"
}
'{
"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"
}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 campoevents, 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.
{ "events": ["MESSAGE_RECEIVED", "CONNECTED", "DISCONNECTED"] }
Deshabilitar temporalmente
{ "status": "DISABLED" }
{ "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.
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.http o https, de hasta 2048 caracteres, con un host que resuelve solo a direcciones públicas.Autorizaciones
Secret Key generada en el panel de Seguridad de Omni Z-API
Parámetros de ruta
ID del webhook predeterminado
"5B7E3A90C2D14F6A8E1B2C3D4E5F6A7B"
Cuerpo
Todos los campos son opcionales: solo se actualizan los campos enviados.
Nueva URL de destino. Solo se comprueba la URL distinta de la guardada.
"https://nova-url.suempresa.com/webhooks/omni-zapi"
Descripción opcional del webhook
"Eventos de todos los canales"
Nueva lista de eventos de canal. Sustituye la lista entera. Para mantener los eventos, omite el campo.
MESSAGE_RECEIVED, MESSAGE_DELIVERY, MESSAGE_STATUS, RECEIVED_STATUS, RECEIVED_AND_DELIVERY, CONNECTED, DISCONNECTED, PRESENCE_CHAT, INITIAL_DATA, BLOCK [
"MESSAGE_RECEIVED",
"MESSAGE_STATUS",
"DISCONNECTED"
]
DISABLED pausa el webhook sin eliminarlo; ENABLED lo vuelve a habilitar
ENABLED, DISABLED 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.
Tipo de autenticación (forma plana). Alternativa al objeto auth.
NONE, BEARER, API_KEY, BASIC, CUSTOM_HEADER Credencial para BEARER (forma plana)
Credencial para API_KEY (forma plana)
Cómo se autentica Omni Z-API al llamar a tu URL
Show child attributes
Show child attributes
DEFAULT o Z_API. CHATWOOT se rechaza con 422. Omítelo para no cambiarlo.
DEFAULT, Z_API Mapa libre de atributos extra
Respuesta
Webhook predeterminado actualizado. El secret viene como null, salvo cuando la petición trae signing: true.
ID del webhook predeterminado
"5B7E3A90C2D14F6A8E1B2C3D4E5F6A7B"
Siempre null: el webhook predeterminado no pertenece a un canal
null
Siempre null. Campo heredado, mantenido por compatibilidad
null
"https://app.suempresa.com/webhooks/omni-zapi"
"Eventos de todos los canales"
MESSAGE_RECEIVED, MESSAGE_DELIVERY, MESSAGE_STATUS, RECEIVED_STATUS, RECEIVED_AND_DELIVERY, CONNECTED, DISCONNECTED, PRESENCE_CHAT, INITIAL_DATA, BLOCK ENABLED o DISABLED
ENABLED, DISABLED true cuando la firma HMAC está activa
Secreto de la firma HMAC. Viene relleno solo en la respuesta que lo generó (signing: true); en las demás, null.
Resumen de la autenticación configurada. Las credenciales no se devuelven.
Show child attributes
Show child attributes
DEFAULT, Z_API Fecha de creación
Fecha de la última modificación