Для разработчиков

API и интеграции b8q

REST API для управления данными, WebSocket для событий в реальном времени и вебхуки для уведомлений. Всё, что нужно, чтобы связать b8q с вашими системами.

Обзор

Три интерфейса для любых задач

Полный набор API для автоматизации, интеграции и расширения возможностей мессенджера.

REST API

CRUD-операции над всеми сущностями: пользователи, чаты, сообщения, файлы, документы, задачи. Ответы в JSON, пагинация, фильтрация. Базовый URL: /api/v1/

WebSocket API

Подписка на события в реальном времени: новые сообщения, статусы прочтения, индикатор набора, обновления задач. Подключение через wss://

Webhooks

HTTP-уведомления о событиях в мессенджере. Указываете URL и типы событий, и b8q отправляет POST-запрос при каждом срабатывании.

REST API

Основные эндпоинты

Все запросы требуют заголовок Authorization: Bearer <token>. Ответы в JSON, кодировка UTF-8.

Метод	Эндпоинт	Описание
GET	/api/v1/users	Список пользователей с пагинацией
GET	/api/v1/users/:id	Профиль пользователя
GET	/api/v1/chats	Список чатов текущего пользователя
POST	/api/v1/chats	Создание нового чата
GET	/api/v1/chats/:id/messages	Сообщения чата (пагинация, limit/offset)
POST	/api/v1/chats/:id/messages	Отправка сообщения
POST	/api/v1/files	Загрузка файла (multipart/form-data)
GET	/api/v1/files/:id	Скачивание файла
GET	/api/v1/documents	Список документов
GET	/api/v1/boards	Канбан-доски
POST	/api/v1/boards/:id/cards	Создание карточки на доске

Примеры

Примеры кода

Отправка сообщения в чат через API: три строки кода на любом языке.

curl bash

curl -X POST https://your-domain.com/api/v1/chats/42/messages \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"content": "Релиз запланирован на пятницу, 14:00"}'

Python (requests) python

import requests

resp = requests.post(
    "https://your-domain.com/api/v1/chats/42/messages",
    headers={"Authorization": "Bearer YOUR_API_TOKEN"},
    json={"content": "Релиз запланирован на пятницу, 14:00"}
)
print(resp.json())  # {"id": 1337, "chatId": 42, "content": "...", "createdAt": "..."}

JavaScript (fetch) javascript

const resp = await fetch("https://your-domain.com/api/v1/chats/42/messages", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({ content: "Релиз запланирован на пятницу, 14:00" })
});
const data = await resp.json();
console.log(data);

WebSocket

Реальное время через WebSocket

Подключайтесь к wss://your-domain.com/ws?token=YOUR_API_TOKEN и получайте события мгновенно.

Терминал

✓ message.new — новое сообщение
✓ message.read — прочтение сообщения
✓ typing.start / typing.stop — индикатор набора
✓ user.online / user.offline — статус пользователя

JavaScript javascript

const ws = new WebSocket(
  "wss://your-domain.com/ws?token=TOKEN"
);

ws.onmessage = (event) => {
  const data = JSON.parse(event.data);

  if (data.type === "message.new") {
    console.log("Новое:", data.payload);
  }
};

Webhooks

Webhooks для серверных интеграций

Укажите URL и выберите типы событий: b8q будет отправлять POST-запросы с JSON-телом при каждом срабатывании. Для проверки подлинности есть подпись HMAC-SHA256.

Пример payload (message.new) json

{
  "event": "message.new",
  "timestamp": "2026-03-16T10:30:00Z",
  "payload": {
    "id": 1337,
    "chatId": 42,
    "userId": 7,
    "content": "Релиз запланирован на пятницу, 14:00",
    "createdAt": "2026-03-16T10:30:00Z"
  },
  "signature": "sha256=a1b2c3d4e5f6..."
}

Лимиты

Аутентификация и лимиты

Аутентификация

API-токен создаётся в настройках профиля
Передаётся в заголовке Authorization: Bearer <token>
Токен привязан к пользователю и наследует его права доступа
Администраторы могут создавать сервисные токены с ограниченным scope

Rate limits

REST API: 100 запросов в минуту на токен
Отправка сообщений: 30 сообщений в минуту
Загрузка файлов: 10 файлов в минуту, до 100 МБ каждый
WebSocket: без ограничений на входящие события
Webhooks: повторная отправка 3 раза с backoff

Интеграции

Готовые интеграции

Подключаются в настройках администратора за 2–5 минут, без написания кода.

Двусторонний обмен сообщениями: сообщения из Telegram-чата приходят в b8q, ответы из b8q уходят обратно в Telegram. Настройка через BotFather. Доступно на тарифах «Бизнес» и «Корпорация».

Email

Уведомления о новых сообщениях на почту для тех, кто не в сети. Правила настраиваются: все сообщения, только упоминания или только личные чаты. Отправка через SMTP или API-провайдера.

Incoming Webhooks

Публикуйте сообщения в чаты b8q из внешних систем: CI/CD, мониторинга, CRM. Один URL и POST-запрос с JSON, и уведомление появляется в нужном чате.

Готовы к интеграции?

Запросите демо-доступ: получите API-токен и тестируйте API в течение 14 дней.

Запросить демо Смотреть тарифы