API вебхуків

Отримання сповіщень про події в реальному часі

Вебхуки дозволяють отримувати сповіщення в реальному часі, коли події відбуваються у ваших ботах. Замість опитування нашого API, налаштуйте URL вебхука, і ми миттєво надсилатимемо вам події.

Доступні події

message.received

Нове повідомлення в чаті

message.edited

Повідомлення було відредаговано

member.joined

Користувач приєднався до групи

member.left

Користувач покинув групу

bot.added

Бота додано до групи

bot.removed

Бота видалено з групи

command.executed

Виконано команду бота

module.triggered

Спрацювала дія модуля

Endpoints

GET
/api/webhooks

Перелік усіх налаштованих вебхуків

botId
POST
/api/webhooks

Створення нового ендпоінта вебхука

urleventssecret
PATCH
/api/webhooks/:id

Оновлення конфігурації вебхука

urleventsstatus
DELETE
/api/webhooks/:id

Видалення вебхука

id
POST
/api/webhooks/:id/test

Надсилання тестової події на ваш вебхук

id

Безпека вебхуків

Перевірка підпису

Усі навантаження вебхуків містять заголовок підпису для перевірки:

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