Pular para o conteúdo principal
PUT
/
instances
/
{instanceId}
/
token
/
{token}
/
update-webhook-connected
Ao conectar
curl --request PUT \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/update-webhook-connected \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "<string>"
}
'
{
  "type": "<string>",
  "connected": true,
  "phone": "<string>",
  "momment": 123,
  "instanceId": "<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 conexão do celular com o Z-API. É acionado quando o Z-API se conecta ao WhatsApp — durante a leitura do QR code, reinício da instância, etc.
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 conexão

​
Request Body

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

​
Retorno do webhook

​
type
string
Tipo do evento: ConnectedCallback
​
connected
boolean
Status de conexão da instância
​
phone
string
Número de telefone conectado
​
momment
integer
Timestamp da conexão
​
instanceId
string
Identificador da instância
{
  "type": "ConnectedCallback",
  "connected": true,
  "momment": 26151515154,
  "instanceId": "instance.id",
  "phone": "5544999999999"
}

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