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.suaempresa.com/webhooks/omni-zapi",
"description": "Eventos de todos os canais",
"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"
}Atualizar webhook padrão
Atualize a configuração de um webhook padrão 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.suaempresa.com/webhooks/omni-zapi",
"description": "Eventos de todos os canais",
"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"
}Conceituação
Atualiza parcialmente um webhook padrão. Apenas os campos enviados no body são atualizados; os demais permanecem como estão.Atualizar eventos
Se enviar o campoevents, a lista substitui os eventos existentes e deve conter só eventos de canal (evento de template resulta em 422). Lista vazia resulta em 400: para manter os eventos, omita o campo.
{ "events": ["MESSAGE_RECEIVED", "CONNECTED", "DISCONNECTED"] }
Desabilitar temporariamente
{ "status": "DISABLED" }
{ "status": "ENABLED" }. O webhook desabilitado continua contando no limite de 5 do workspace.
Formato
payloadFormat aceita DEFAULT e Z_API. CHATWOOT resulta em 422.
Assinatura HMAC
signing: true gera um novo secret, retornado apenas nesta resposta; signing: false desliga a assinatura. Sem signing: true, a resposta traz secret: null e o segredo gravado não muda.
signing: true gera um secret novo toda vez, inclusive quando a assinatura já estava ligada e você só queria mudar outro campo. Para manter o segredo atual, omita o campo signing.http ou https, até 2048 caracteres, com host que resolve só para endereços públicos.Autorizações
Secret Key gerada no painel de Segurança do Omni Z-API
Parâmetros de caminho
ID do webhook padrão
"5B7E3A90C2D14F6A8E1B2C3D4E5F6A7B"
Corpo
Todos os campos são opcionais: apenas os campos enviados são atualizados.
Nova URL de destino. Só a URL diferente da gravada é conferida.
"https://nova-url.suaempresa.com/webhooks/omni-zapi"
Descrição opcional do webhook
"Eventos de todos os canais"
Nova lista de eventos de canal. Substitui a lista inteira. Para manter os eventos, omita o 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 o webhook sem excluí-lo; ENABLED volta a habilitá-lo
ENABLED, DISABLED true gera um secret novo (devolvido só nesta resposta), mesmo que a assinatura já estivesse ligada. false desliga a assinatura. Omita para não mudar.
Tipo de autenticação (forma plana). Alternativa ao objeto auth.
NONE, BEARER, API_KEY, BASIC, CUSTOM_HEADER Credencial para BEARER (forma plana)
Credencial para API_KEY (forma plana)
Como o Omni Z-API se autentica ao chamar a sua URL
Show child attributes
Show child attributes
DEFAULT ou Z_API. CHATWOOT é recusado com 422. Omita para não mudar.
DEFAULT, Z_API Mapa livre de atributos extras
Resposta
Webhook padrão atualizado. O secret vem null, salvo quando o pedido traz signing: true.
ID do webhook padrão
"5B7E3A90C2D14F6A8E1B2C3D4E5F6A7B"
Sempre null: o webhook padrão não pertence a um canal
null
Sempre null. Campo legado, mantido por compatibilidade
null
"https://app.suaempresa.com/webhooks/omni-zapi"
"Eventos de todos os canais"
MESSAGE_RECEIVED, MESSAGE_DELIVERY, MESSAGE_STATUS, RECEIVED_STATUS, RECEIVED_AND_DELIVERY, CONNECTED, DISCONNECTED, PRESENCE_CHAT, INITIAL_DATA, BLOCK ENABLED ou DISABLED
ENABLED, DISABLED true quando a assinatura HMAC está ligada
Segredo da assinatura HMAC. Vem preenchido só na resposta que o gerou (signing: true); nas demais, null.
Resumo da autenticação configurada. As credenciais não são retornadas.
Show child attributes
Show child attributes
DEFAULT, Z_API Data de criação
Data da última alteração