Skip to main content
PUT
Ao receber - enviadas por mim
O webhook ReceivedCallback pode ser configurado de duas formas: recebendo apenas as mensagens enviadas por outros usuários, ou recebendo também as mensagens enviadas por você mesmo.
Ao configurar o webhook através do endpoint Ao receber - enviadas por mim, a API passa a dar prioridade automaticamente à URL configurada nesse endpoint. Ou seja, mesmo que você já tenha um webhook configurado no endpoint Ao receber, ele permanece salvo, porém deixa de ser utilizado enquanto o outro estiver ativo.Para voltar a utilizar a URL configurada no endpoint Ao receber e deixar de receber as mensagens enviadas por você mesmo, é necessário desativar a opção Notificar as enviadas por mim também através do endpoint Atualizar notificar enviadas por mim.

Conceituação

Este webhook funciona como o retorno padrão de mensagens recebidas, porém com uma particularidade em relação ao Ao receber comum: ao configurá-lo, a URL do webhook de recebimento é atualizada para que as mensagens enviadas por você mesmo também sejam notificadas.
O Z-API não aceita webhooks que não sejam HTTPS.
Os arquivos de mídia ficam disponíveis por 30 dias no armazenamento da Z-API. Para ver todos os exemplos de retorno por tipo de mensagem, consulte a página Exemplos de retorno.

Atualizar webhook

string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
string
obrigatório
Token da sua instância Z-API.

Body

string
obrigatório
URL do webhook de recebimento

Request Body


Response

200

405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou PUT conforme especificado no início deste tópico.

415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.