Documentação do KiraGo

Webhook
Painel Swagger

Webhook

Endpoints para configurar webhooks que receberão notificações de eventos.

GET /webhook

Obtém o webhook configurado e os eventos assinados.

Resposta:

{
  "code": 200,
  "data": {
    "subscribe": ["All"],
    "webhook": "https://example.net/webhook"
  },
  "success": true
}

POST /webhook

Configura um webhook para receber eventos.

Parâmetros do corpo:

Parâmetro Tipo Descrição
webhook string URL do webhook que receberá as chamadas
events Array[string] Lista de tipos de evento para assinar. Recomendado: use ["All"].
Mensagens e comunicação: Message, UndecryptableMessage, Receipt, MediaRetry
Grupos e contatos: GroupInfo, JoinedGroup, Picture, BlocklistChange, Blocklist
Conexão e sessão: Connected, Disconnected, ConnectFailure, KeepAliveRestored, KeepAliveTimeout, LoggedOut, ClientOutdated, TemporaryBan, StreamError, StreamReplaced, PairSuccess, PairError, QR, QRTimeout, QRScannedWithoutMultidevice
Privacidade e configurações: PrivacySettings, PushNameSetting, UserAbout
Sincronização e estado: AppState, AppStateSyncComplete, HistorySync, OfflineSyncCompleted, OfflineSyncPreview
Chamadas: CallOffer, CallAccept, CallTerminate, CallOfferNotice, CallRelayLatency
Presença e atividade: Presence, ChatPresence
Outros: IdentityChange, CATRefreshError, NewsletterJoin, NewsletterLeave, NewsletterMuteChange, NewsletterLiveUpdate, FBMessage, All
Veja também a seção Tipos de eventos disponíveis abaixo.
active boolean Define se o webhook está ativo ou não. Padrão: true

Exemplo de requisição:

{
  "webhook": "https://example.net/webhook",
  "events": ["All"]
}

Resposta:

{
  "code": 200,
  "data": {
    "webhook": "https://example.net/webhook",
    "events": ["All"]
  },
  "success": true
}

PUT /webhook

Atualiza a configuração do webhook. Dá para atualizar apenas a URL, apenas os eventos, ou ambos.

Parâmetros do corpo:

Parâmetro Tipo Descrição
webhook string Nova URL do webhook (opcional se for atualizar apenas eventos)
events Array[string] Nova lista de eventos (opcional se for atualizar apenas a URL)
active boolean Ativar ou desativar o webhook

Exemplos de requisição:

// Atualizar apenas eventos
{
  "events": ["All"],
  "active": true
}

// Atualizar apenas URL
{
  "webhook": "https://novo-endpoint.com/webhook",
  "active": true
}

// Desativar webhook
{
  "active": false
}

DELETE /webhook

Remove o webhook e limpa a configuração de eventos.

Resposta:

{
  "code": 200,
  "data": {
    "message": "Webhook removed successfully"
  },
  "success": true
}

Tipos de eventos disponíveis

Abaixo está a lista completa de eventos que você pode assinar:

Mensagens e comunicação

  • Message - Mensagem recebida ou enviada
  • UndecryptableMessage - Mensagem que não pôde ser descriptografada
  • Receipt - Confirmação de entrega/leitura
  • MediaRetry - Tentativa de reenvio de mídia

Grupos e contatos

  • GroupInfo - Informações do grupo atualizadas
  • JoinedGroup - Entrou em um grupo
  • Picture - Foto de perfil atualizada
  • BlocklistChange - Alteração na lista de bloqueio
  • Blocklist - Lista de bloqueio

Conexão e sessão

  • Connected - Conectado ao WhatsApp
  • Disconnected - Desconectado do WhatsApp
  • ConnectFailure - Falha na conexão
  • KeepAliveRestored - Conexão restaurada
  • KeepAliveTimeout - Timeout de conexão
  • LoggedOut - Sessão encerrada
  • ClientOutdated - Cliente desatualizado
  • TemporaryBan - Banimento temporário
  • StreamError - Erro de stream
  • StreamReplaced - Stream substituído
  • PairSuccess - Pareamento bem-sucedido
  • PairError - Erro ao parear
  • QR - QR code gerado
  • QRTimeout - Timeout do QR code
  • QRScannedWithoutMultidevice - QR escaneado sem multi-dispositivo

Privacidade e configurações

  • PrivacySettings - Configurações de privacidade
  • PushNameSetting - Nome de exibição alterado
  • UserAbout - Status/Sobre atualizado

Sincronização e estado

  • AppState - Estado do aplicativo
  • AppStateSyncComplete - Sincronização concluída
  • HistorySync - Sincronização de histórico
  • OfflineSyncCompleted - Sincronização offline concluída
  • OfflineSyncPreview - Prévia da sincronização offline

Chamadas

  • CallOffer - Oferta de chamada
  • CallAccept - Chamada aceita
  • CallTerminate - Chamada encerrada
  • CallOfferNotice - Aviso de oferta de chamada
  • CallRelayLatency - Latência do relay da chamada

Presença e atividade

  • Presence - Status de presença
  • ChatPresence - Presença no chat (digitando)

Outros

  • IdentityChange - Mudança de identidade
  • CATRefreshError - Erro de atualização do CAT
  • NewsletterJoin - Entrou na newsletter
  • NewsletterLeave - Saiu da newsletter
  • NewsletterMuteChange - Alteração de silenciar newsletter
  • NewsletterLiveUpdate - Atualização ao vivo da newsletter
  • FBMessage - Mensagem da ponte do Facebook
  • All - Receber todos os eventos
← Sessão Próximo: Chat →