Входящие вебхуки: сообщения из ваших сервисов
Как получить адрес, по которому любой сервис одним запросом публикует текст в нужном канале Syncra.
Входящий вебхук — это секретный адрес. Если отправить на него короткий запрос с текстом, бот опубликует этот текст в канале. Через вебхук в канал приходят уведомления о сборках, оплатах и сбоях из любого сервиса, который умеет отправлять запросы на адрес. Программировать бота для этого не нужно.
Создавать вебхуки могут владелец и администратор рабочего пространства. Вебхук принадлежит боту, поэтому сначала нужен бот: Боты: как создать и подключить.
Как создать вебхук
- Откройте настройки рабочего пространства, вкладку «Боты», и страницу нужного бота.
- Найдите раздел «Входящие вебхуки».
- В поле «Канал» выберите канал. В личные сообщения вебхук писать не может.
- При желании введите «Название (необязательно)», например «Оповещения из Grafana».
- Нажмите «Создать вебхук». Бот вступит в этот канал сам.
- В строке вебхука появится адрес. Скопируйте его кнопкой «Скопировать» рядом.
Адрес секретный: любой, кто его знает, может писать в канал. Не публикуйте его в открытом коде и общедоступных репозиториях.
Как отправить сообщение
Отправьте POST-запрос на адрес вебхука с телом JSON, в котором есть поле text, от 1 до 4000 символов:
curl -X POST "https://ai-syncra.ru/api/webhooks/whk_..." \
-H "Content-Type: application/json" \
-d '{"text":"Деплой завершён"}'
Заголовок авторизации не нужен. В ответ придёт {"ok":true,"messageId":"..."}, а сообщение появится в канале от имени бота.
Ограничения
- Не больше 60 запросов в минуту на один вебхук. На запросы сверх этого Syncra отвечает кодом 429 «Too many requests».
- Вебхук отправляет только текст. Приложить файл, ответить в ветке, задать сообщению своё имя или аватар нельзя.
- Упоминания
@channelи@hereв тексте вебхука никого не оповещают. - Если такого адреса нет, вебхук отключён или выключен сам бот, Syncra ответит кодом 404.
Как удалить вебхук
В строке вебхука нажмите «Удалить» и подтвердите. Запросы на этот адрес сразу начнут завершаться ошибкой. Отменить удаление нельзя: создайте новый вебхук и замените адрес в сервисе.
Когда вебхука мало
Если нужно отвечать в ветках, читать сообщения или прикладывать файлы, используйте токен бота и API ботов. Пример первого запроса есть в статье «Боты: как создать и подключить».
Что ещё почитать
Обновлено: