Вебхуки: события в вашу систему

Вебхук — это запрос, который Докифай отправляет на ваш сервер, когда что-то происходит: документ открыли, файл скачали, в команду вступил человек. Так CRM узнаёт о просмотре КП сразу, без опроса API.

Вебхуки доступны на тарифах «Команда» и «Бизнес». Настраивают их владелец и администраторы.

Как подключить

1. «Настройки» → «Веб-хуки» → «Добавить вебхук».
2. Укажите «URL эндпоинта» — адрес на вашем сервере, который примет запрос.
3. Отметьте события и при желании добавьте описание.
4. Сохраните и скопируйте секрет подписи из окна «Скопируйте секрет подписи» — он показывается один раз.

События

Что приходит

POST-запрос с JSON: название события, время, рабочая область и данные события. В заголовках:

• X-Docify-Event — событие;
• X-Docify-Delivery — идентификатор доставки: по нему удобно отсеивать повторы;
• X-Docify-Timestamp — время отправки;
• X-Docify-Signature — подпись sha256=…: HMAC-SHA256 от строки «время.тело» с вашим секретом.

Проверяйте подпись и время на своей стороне — так вы будете уверены, что запрос пришёл от Докифая и не был перехвачен.

Если ваш сервер не ответил

Сервер должен ответить кодом 2xx за 10 секунд. Иначе Докифай повторит отправку — всего до шести попыток в течение примерно восьми часов. Если доставки проваливаются 15 раз подряд, вебхук отключается — статус «Отключён».

В меню вебхука: «Доставки» — последние отправки со статусами и кнопкой «Переотправить», «Изменить», «Сменить секрет» — смена секрета заодно снова включает отключённый вебхук, — и «Удалить». Журнал доставок хранится 30 дней.

Что дальше

• API: ключи доступа — запросы к Докифаю со своей стороны.
• Какие уведомления присылает Докифай — уведомления для людей, а не для систем.