Обзор
Бот предоставляет две системы для real-time обновлений:- WebSocket — для real-time обновлений в веб-админке
- Webhooks — для отправки событий во внешние системы
WebSocket
Подключение
WebSocket endpoint:ws://your-api-host:port/ws
Авторизация через query-параметр:
Формат сообщений
Подтверждение подключения:Поддерживаемые события
| Событие | Описание |
|---|---|
user.created | Создан новый пользователь |
payment.completed | Завершён платёж |
transaction.created | Создана транзакция |
ticket.created | Создан тикет |
ticket.status_changed | Изменён статус тикета |
ticket.message_added | Новое сообщение в тикете |
Webhooks
Создание webhook
Поддерживаемые события
user.created— создан новый пользовательpayment.completed— завершён платёжtransaction.created— создана транзакцияticket.created— создан тикетticket.status_changed— изменён статус тикета
Заголовки запроса
| Заголовок | Описание |
|---|---|
Content-Type | application/json |
X-Webhook-Event | Тип события (например, user.created) |
X-Webhook-Id | ID webhook |
X-Webhook-Signature | HMAC-SHA256 подпись (если указан secret) |
Подпись payload
Если при создании webhook указанsecret, payload подписывается HMAC-SHA256:
API эндпоинты
| Метод | Endpoint | Описание |
|---|---|---|
GET | /webhooks | Список webhooks |
GET | /webhooks/{id} | Получить webhook |
PATCH | /webhooks/{id} | Обновить webhook |
DELETE | /webhooks/{id} | Удалить webhook |
GET | /webhooks/stats | Статистика |
GET | /webhooks/{id}/deliveries | История доставок |
Статусы доставки
pending— ожидает отправкиsuccess— успешно доставлен (HTTP 200-299)failed— ошибка доставки
Безопасность
- WebSocket: Требует валидный API токен
- Webhooks: Используйте HTTPS, подписывайте payload через
secret, проверяйте подпись на стороне получателя
