Atualizando Webhooks
Este endpoint permite atualizar um webhook existente para uma instância específica.
⚠️ Importante: Alteração de Nome ou URL
Modificar o nome ou a URL de um webhook existente impactará todas as instâncias que utilizam esse webhook. Isso significa que qualquer instância vinculada será automaticamente atualizada para refletir as mudanças.
Se precisar utilizar um novo nome ou uma URL diferente sem afetar instâncias existentes, recomendamos criar um novo webhook em vez de modificar um já em uso.
Dessa forma, o novo webhook será vinculado apenas aos recursos desejados, evitando impactos inesperados em outras configurações.
🔍 Considerações
- Todos os parâmetros são opcionais, sendo possível atualizar apenas os campos desejados.
- Se a URL do webhook for alterada, a API pode exigir uma nova validação.
- O webhook pode ser desativado definindo
enabled
comofalse
.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Identificador único da instância.
Identificador único do webhook.
Body
Lista de eventos que acionam o webhook. Deve conter pelo menos um evento.
group.created
, group.participants_added
, group.participants_demoted
, group.participants_promoted
, group.participants_removed
, group.updated
, instance.connected
, instance.disconnected
, instance.forbidden
, instance.mentioned
, instance.qrcode
, message.deleted
, message.delivered
, message.pinned
, message.reaction
, message.read
, message.received
, message.sent
, message.unpinned
, poll.created
, poll.deleted
, poll.updated
["message.received"]
Define se o webhook está ativado. Padrão: true.
true
Nome do webhook configurado.
"Meu Webhook"
Indica se o webhook está em modo de teste. Padrão: false.
false
URL de teste para validar o webhook, se aplicável.
null
URL para onde os eventos do webhook serão enviados. Obrigatório caso webhook_id
não seja fornecido.
"https://webhook.example.com/receive"
ID de um webhook existente para ser reutilizado. Obrigatório caso url
não seja fornecida.
"2nenz69l0xbf0m3uu9tfo"
Response
Resposta ao registrar um webhook.
Data e hora de criação do webhook.
"2025-03-12T23:12:19.448Z"
Indica se o webhook está ativado.
true
Eventos configurados no webhook.
["message.received"]
Identificador único do webhook.
"3nsnz68l0xbf0m3uu9tfo"
Nome do webhook configurado.
"Meu Webhook"
Indica se o webhook está em modo de teste.
false
URL de teste configurada no webhook, se aplicável.
null
URL para onde os eventos do webhook serão enviados.
"https://webhook.mydomain.com"