Webhooks permitem que você receba notificações em tempo real quando eventos acontecem nos seus bots. Em vez de consultar nossa API, configure uma URL de webhook e enviaremos os eventos para você instantaneamente.

Eventos Disponíveis

message.received

Nova mensagem em um chat

message.edited

Mensagem foi editada

member.joined

Usuário entrou em um grupo

member.left

Usuário saiu de um grupo

bot.added

Bot foi adicionado a um grupo

bot.removed

Bot foi removido de um grupo

command.executed

Comando do bot foi executado

module.triggered

Uma ação de módulo foi acionada

Endpoints

GET

/api/webhooks

Listar todos os webhooks configurados

botId

POST

/api/webhooks

Criar um novo endpoint de webhook

urleventssecret

PATCH

/api/webhooks/:id

Atualizar configuração do webhook

urleventsstatus

DELETE

/api/webhooks/:id

Excluir um webhook

POST

/api/webhooks/:id/test

Enviar um evento de teste para seu webhook

Segurança de Webhook

Verificação de Assinatura

Todos os payloads de webhook incluem um cabeçalho de assinatura para verificação:

X-BotLaunch-Signature: sha256=abc123...

Example Payload

{
  "event": "message.received",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "messageId": "msg_abc123",
    "chatId": "-100123456789",
    "from": {
      "id": 123456789,
      "username": "johndoe"
    },
    "text": "Hello, bot!"
  }
}

Política de Retentativa

If your endpoint returns a non-2xx status, we'll retry up to 3 times with exponential backoff (10s, 30s, 90s). After 3 failures, the webhook is paused.

Explorar Mais

Aprenda sobre melhores práticas de segurança para sua integração com a API.

Security Guide

API de Webhooks