Webhooks - TopoT.im

Что такое Webhooks?

Webhooks позволяют вашему приложению получать уведомления о событиях в TopoT.im в реальном времени. Вместо постоянного опроса API, вы можете настроить URL, на который будут отправляться HTTP POST запросы при наступлении определенных событий.

Настройка Webhook

Для настройки webhook необходимо:

Создать endpoint на вашем сервере для приема POST запросов
Зарегистрировать URL вашего endpoint в настройках приложения
Указать события, на которые вы хотите получать уведомления

POST https://web.topot.im/api/webhooks.php?action=register

Параметры запроса:

url - URL вашего endpoint
events - массив событий (new_message, message_edited, user_joined, etc.)
secret - секретный ключ для подписи запросов

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

new_message - новое сообщение в чате
message_edited - сообщение отредактировано
message_deleted - сообщение удалено
user_joined - пользователь присоединился к группе
user_left - пользователь покинул группу
group_created - создана новая группа
channel_created - создан новый канал

Безопасность

Все webhook запросы подписываются с использованием HMAC SHA256. Проверяйте подпись в заголовке X-Webhook-Signature для подтверждения подлинности запроса.

X-Webhook-Signature: sha256=...

Пример запроса

Пример тела POST запроса, который будет отправлен на ваш endpoint:

{
  "event": "new_message",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "message_id": 12345,
    "chat_id": 678,
    "user_id": 90,
    "content": "Текст сообщения"
  }
}