REST API и вебхуки
2Sync можно связать с вашими системами: CRM, сайтом, чат-ботом, таск-трекером или мессенджером. REST API позволяет читать и менять записи и читать wiki, а вебхуки сами сообщают вашему серверу о событиях в проекте.
Где найти настройки
Откройте Инбокс отзывов и нажмите ⚙ Настройки.
Перейдите на вкладку Отзывы и API. Она видна менеджерам проекта.
В блоке API для своего бэкенда лежит секрет проекта. Нажмите Показать, чтобы увидеть его. Секрет держите только на сервере: в коде страниц сайта его увидит любой посетитель. Если секрет утёк, нажмите Выпустить новый секрет, старый перестанет работать сразу.
REST API
Каждый запрос передаёт секрет в заголовке Authorization: Bearer <секрет>.
Запрос | Что делает |
|---|---|
| список записей с фильтрами |
| одна запись по ключу |
| создать запись |
| изменить запись, например статус |
| страницы wiki |
| базы данных и их строки |
| отправить отзыв в инбокс |
Статусы: NEW, BACKLOG, IN_PROGRESS, DONE. Типы: TICKET (идея), PROBLEM, TASK. Приватные страницы через API не видны.
Пример: создать задачу и назначить её на коллегу.
curl -X POST https://2sync.ru/api/public/v1/items \
-H "Authorization: Bearer <секрет>" \
-H "Content-Type: application/json" \
-d '{"title":"Обновить баннер","type":"TASK","assignee":"anna@example.com"}'Вебхуки
Вебхук — адрес на вашем сервере, куда 2Sync отправит POST с JSON, когда в проекте что-то произойдёт.
В блоке Вебхуки впишите адрес.
Отметьте события, которые нужны. Если не отметить ничего, придут все.
Нажмите Добавить вебхук, затем Проверить, чтобы отправить тестовое событие.
События: создана и изменена запись, комментарий к записи, создана и изменена страница, комментарий к странице, новая и изменённая строка базы, новый отзыв в инбоксе.
Каждый запрос подписан: в заголовке X-Bplan-Signature лежит sha256=… — HMAC тела запроса с секретом вебхука, а в X-Bplan-Event — название события. Секрет вебхука показывает кнопка Секрет. Проверяйте подпись, чтобы принимать запросы только от 2Sync. Приватные страницы в вебхуки не попадают.
Под адресом вебхука видно, чем ответил ваш сервер в последний раз. Вебхук можно временно выключить кнопкой Выключить.
Частые вопросы
Можно ли отправлять отзывы из своего приложения?
Да, через POST /api/public/v1/feedback. Необязательные поля: email, name, pageUrl и screenshot (картинка в base64). Отзыв придёт в инбокс с отметкой API.
Сколько вебхуков можно добавить?
До 10 на проект.