instance.paired

EVENTOinstance.paireddesde M11envelope v1

Pareamento concluído.

Quando é emitido

Emitido uma vez por pareamento: a instância estava esperando QR ou código e conectou. Reconexões não disparam este evento (use instance.status). via_link é true quando havia um link de pareamento válido — ele é consumido por este pareamento.

Campos de data

Campo	Tipo	Descrição
phone	string	Número pareado (só dígitos).
via_link	boolean	Havia link de pareamento válido (agora consumido).

O envelope (id, type, version, instance_id, timestamp,data) está em Visão geral. Campos novos podem ser adicionados emdata sem mudar a versão: ignore os que não conhecer.

Exemplos

Corpo do POST

{
  "id": "evt_8c2f6a0d4e1b3957",
  "type": "instance.paired",
  "version": 1,
  "instance_id": "inst_7f3a9c2e5b1d4086",
  "timestamp": "2026-10-18T16:58:03.120Z",
  "data": {
    "phone": "5511999999999",
    "via_link": true
  }
}

Entrega e ordem

• Por webhook: pelo menos uma vez, com retry por até 24 horas. O mesmo evento pode chegar duas vezes: deduplique porX-LiteZap-Event-Id. Veja Entrega e retentativas.
• A ordem entre eventos não é garantida (retentativas reordenam): use timestamp.
• Por SSE: ao vivo, sem replay. Veja Tempo real com SSE.
• Para assinar só este tipo: "events": ["instance.paired"] no webhook, ou?types=instance.paired no SSE.

Relacionados: instance.status · instance.qr · instance.pair_code

Equivalente na Z-API: (sem equivalente; "Ao conectar" sem distinguir pareamento).