API Webhook-ов

Получение уведомлений о событиях в реальном времени

Webhook-и позволяют получать уведомления в реальном времени при возникновении событий в ваших ботах. Вместо опроса нашего API настройте URL webhook-а, и мы мгновенно отправим вам события.

Доступные события

message.received

Новое сообщение в чате

message.edited

Сообщение было отредактировано

member.joined

Пользователь присоединился к группе

member.left

Пользователь покинул группу

bot.added

Бот был добавлен в группу

bot.removed

Бот был удалён из группы

command.executed

Была выполнена команда бота

module.triggered

Было вызвано действие модуля

Endpoints

GET
/api/webhooks

Список всех настроенных webhook-ов

botId
POST
/api/webhooks

Создание нового эндпоинта webhook

urleventssecret
PATCH
/api/webhooks/:id

Обновление конфигурации webhook

urleventsstatus
DELETE
/api/webhooks/:id

Удаление webhook-а

id
POST
/api/webhooks/:id/test

Отправка тестового события на ваш webhook

id

Безопасность Webhook-ов

Проверка подписи

Все данные webhook-ов содержат заголовок подписи для проверки:

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!"
  }
}

Политика повторных попыток

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.

Узнать больше

Узнайте о лучших практиках безопасности для вашей API-интеграции.

Security Guide