Skip to main content
POST
/
webhook
Configurar Webhook
curl --request POST \
  --url https://api.example.com/webhook

​
Descricao

Configura o webhook que sera chamado via POST sempre que um evento inscrito ocorrer. Use este endpoint para configurar o webhook pela primeira vez.

​
Request

​
Headers

token: SEU_TOKEN
Content-Type: application/json

​
Body

{
  "webhook": "https://seusite.com/webhook",
  "events": ["Message", "ReadReceipt"],
  "active": true
}
CampoTipoObrigatorioDescricao
webhookstringSimURL que recebera os eventos via POST
eventsarrayNaoLista de eventos para inscrever
activebooleanNaoSe o webhook esta ativo

​
Response

​
Sucesso (200)

{
  "code": 200,
  "data": {
    "webhook": "https://seusite.com/webhook"
  },
  "success": true
}

​
Exemplo cURL

curl -X POST 'https://api.bliper.ai/webhook' \
  -H 'token: SEU_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "webhook": "https://seusite.com/webhook",
    "events": ["Message", "ReadReceipt"],
    "active": true
  }'

​
Eventos Disponiveis

EventoDescricao
MessageMensagens recebidas e enviadas
ReadReceiptConfirmacoes de leitura
HistorySyncSincronizacao de historico
ChatPresenceStatus de digitando/online
AllTodos os eventos

​
Payload do Webhook

Quando um evento ocorre, seu webhook recebera um POST com: 
{
  "event": {
    "Info": {
      "MessageSource": {
        "Chat": "[email protected]",
        "Sender": "[email protected]"
      },
      "ID": "ABC123DEF456",
      "Timestamp": "2024-01-15T10:30:00-03:00"
    },
    "Message": {
      "Conversation": "Ola, tudo bem?"
    }
  },
  "type": "Message",
  "token": "SEU_TOKEN"
}
Certifique-se de que sua URL de webhook e acessivel publicamente e responde com status 200.
Use All na lista de eventos para receber todos os tipos de eventos.