Докифай
Чем можем помочь?

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

5 мин чтения · обновлено 15.10.2026

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

Видеоурок: Как подключить API и вебхуки.

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

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

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

Сервисы автоматизации могут подключиться и сами — по API-ключу. Такие вебхуки отмечены «Подключён по API-ключу» с названием ключа. Подробнее — в статье Albato и другие сервисы автоматизации: Докифай в CRM без программиста.

раздел «Вебхуки»

События

Событие Когда
link.visited Открыли ссылку на файл или дата-рум — примерно через минуту, вместе с временем просмотра (time_seconds)
visit.engaged Визит закончился — через 30 минут без активности: окончательное время чтения, доля страниц и скачивание
file.downloaded Скачали файл. «Скачать всё» в дата-руме — одно событие на архив, с archive: true и числом документов files
agreement.accepted Получатель принял соглашение перед просмотром — с именем, почтой и редакцией
question.asked Получатель задал вопрос отправителю — с текстом вопроса, документом и страницей
contact.requested Получатель нажал «Связаться» или «Назначить встречу» рядом с документом — с действием (contact, meeting) и способом связи (channel). Раз за визит на каждую кнопку
offer.accepted Получатель нажал «Принять предложение» — с именем, почтой и комментарием
access.requested У человека не открылась ссылка, и он просит доступ — с почтой, именем, сообщением и причиной (reason): срок истёк, ссылка выключена, адреса нет в списке и другие. Если доступ просят коллеге — кто переслал (forwarded_by)
link.forwarded Получатель переслал документ коллеге (origin: forward) или коллега получил свою ссылку вместо пересланной (claim) — ссылка коллеги, исходная ссылка, кто переслал и кому
file.created, file.deleted Загрузили или удалили файл — в том числе получатель прислал файл в дата-рум
file.processed, file.failed Файл или его новая версия обработались или нет — с причиной (reason)
link.created, link.deleted Создали или удалили ссылку
site.created, site.deleted Создали или удалили дата-рум
contact.created Появился контакт
member.joined В область вступил новый участник
payment.succeeded Прошла оплата тарифа

Что приходит

POST-запрос с JSON: идентификатор события id, название события, время, рабочая область, пометка test и данные события. У тестового события test — true. Повторная доставка того же события приходит с тем же id — по нему удобно отсеивать дубли.

В событиях об открытии, итоге визита, скачивании, вопросе и соглашении есть адрес ссылки link_url и человек contact: почта, имя, компания, должность и телефон. В событиях об открытии и итоге визита — ещё время чтения, доля открытых страниц и город. Идентификаторы ссылки, документа, визита и человека позволяют достать подробности через API.

В событии об открытии есть и form — что человек указал в форме доступа: name, company, position, phone. Если форма ничего не спрашивала, там null. Компания в contact — из карточки, а в form — как её написал сам человек.

В заголовках:

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

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

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

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

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

Тестовое событие отправляется один раз, без повторов, и не отключает вебхук, даже если ваш сервер не ответил. Оно уходит и выключенному вебхуку — так удобно проверить сервер после починки.

Что дальше

← Ко всем статьям