Webhooks e Eventos

Server-Sent Events (SSE)

Abre conexão Server-Sent Events para receber eventos em tempo real.

GEThttps://api.zapzapapi.com/api/v1/{instanceId}/sse

Autenticação por cabeçalhos x-api-key e x-api-secret.

Parâmetros

NomeTipoOndeObrigatórioDescrição
tokentextcorpoNãoToken de autenticação da instância
eventstextcorpoNãoTipos de eventos a serem recebidos. Suporta dois formatos: - Separados por vírgula: `?events=chats,messages` - Parâmetros repetidos: `?events=chats&events=messages`
excludeMessagestextcorpoNãoTipos de mensagens a serem excluídas do evento `messages`. Suporta dois formatos: - Separados por vírgula: `?excludeMessages=poll,reaction` - Parâmetros repetidos: `?excludeMessages=poll&excludeMessages=reaction`

Exemplo de requisição

curl

curl -X GET "https://api.zapzapapi.com/api/v1/{instanceId}/sse" \
  -H "x-api-key: SUA_API_KEY" \
  -H "x-api-secret: SEU_API_SECRET"

Node.js

const res = await fetch("https://api.zapzapapi.com/api/v1/{instanceId}/sse", {
  method: "GET",
  headers: {
    "x-api-key": "SUA_API_KEY",
    "x-api-secret": "SEU_API_SECRET",
  },
});
console.log(await res.json());

Python

import requests

res = requests.get(
    "https://api.zapzapapi.com/api/v1/{instanceId}/sse",
    headers={"x-api-key": "SUA_API_KEY", "x-api-secret": "SEU_API_SECRET"},
)
print(res.json())

Exemplo de resposta

JSON

{}

Os valores são ilustrativos; os campos seguem o formato real da resposta.

Ver referência completa

Pegue suas chaves de API

Crie sua conta, conecte um número em minutos e comece a usar a API. R$15 por número ativo/mês, com crédito de boas-vindas ao criar a conta, sujeito à campanha vigente.