diapi
POST/webhook

Define a configuração de webhook

Descrição

Define a URL de webhook da conexão e quais eventos serão enviados para ela.

O corpo aceita Webhook (URL de destino) e Subscribe (lista de eventos).

Eventos disponíveis:

EventoO que envia
AllTodos os eventos abaixo de uma só vez.
MessageMensagens recebidas e enviadas: texto, mídia, áudio, botões, listas e reações.
ReadReceiptConfirmações de entrega e de leitura das mensagens enviadas.
PresenceContato ficou online/offline ou atualizou o "visto por último".
ChatPresenceIndicadores dentro da conversa: "digitando…" e "gravando áudio…".
HistorySyncCarga do histórico após conectar: conversas, contatos, grupos e participantes.
CallChamadas recebidas: oferta, aceite, rejeição e encerramento.
NewsletterAtualizações de canais/newsletters acompanhados pela conexão.

Enviar ["All"] substitui qualquer seleção individual. Para trocar apenas os eventos, sem reconectar a sessão, use POST /session/update-events.

Parâmetros

Corpo da requisição

NomeTipoLocalizaçãoObrigatório
WebhookURLstringbodySim

Exemplo de requisição

curl -X POST 'https://api-server.dichat.com.br/webhook' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "Subscribe": [
      "All"
    ],
    "Webhook": "https://meu-site.com.br/webhook"
  }'

Testar endpoint

...

Respostas

200Response
application/json
{
  "code": 200,
  "data": {
    "webhook": "https://example.net/webhook"
  },
  "success": true
}