Pular para o conteúdo principal
PUT
/
instances
/
{instanceId}
/
token
/
{token}
/
update-webhook-delivery
Ao enviar
curl --request PUT \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/update-webhook-delivery \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "<string>"
}
'
{
  "phone": "<string>",
  "zaapId": "<string>",
  "messageId": "<string>",
  "instanceId": "<string>",
  "momment": 123,
  "type": "<string>",
  "error": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Esse é o webhook de retorno de mensagens enviadas.
O Z-API não aceita webhooks que não sejam HTTPS.

​
Atualizar webhook

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

​
Body

​
value
string
obrigatório
URL do webhook de delivery

​
Request Body

{
  "value": "https://endereco-do-seu-sistema.com.br/instancia/SUA_INSTANCIA/delivery"
}

​
Retorno do webhook

​
Atributos do retorno

​
phone
string
Número de telefone de destino da mensagem
​
zaapId
string
Identificador da mensagem na conversa
​
messageId
string
Identificador da mensagem no WhatsApp
​
instanceId
string
Identificador da instância
​
momment
integer
Momento em que o evento foi disparado (timestamp em milissegundos)
​
type
string
Tipo do evento da instância, nesse caso será DeliveryCallback
​
error
string
Presente apenas em casos de erro. Contém a descrição do erro ocorrido no envio da mensagem. Confira a lista completa de erros possíveis nos Exemplos de retorno de Ao enviar
{
  "phone": "554499999999",
  "zaapId": "A20DA9C0183A2D35A260F53F5D2B9244",
  "messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
  "instanceId": "instance.id",
  "momment": 1777494009341,
  "type": "DeliveryCallback"
}

​
Response

​
200

{
  "value": true
}

​
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”.