Перейти к основному содержимому

Webhook

Webhook позволяет получать уведомления о событиях Консоль.HRM без постоянного опроса API.

Приём уведомлений​

Подготовьте общедоступный адрес, принимающий POST. Этот адрес должен принимать входящие уведомления без аутентификации и отвечать любым HTTP-кодом группы 2xx после обработки. Такой ответ подтверждает доставку события.

Уведомления могут приходить с IP-адресов:

  • 84.201.153.160
  • 158.160.48.198
  • 84.201.153.101
  • 158.160.170.215

Если получатель ответит не кодом 2xx, предусмотрено 20 попыток отправки с постепенно увеличивающимися интервалами. Обработчик должен корректно переносить повторную доставку одного и того же события.

Подключение​

Для одного кабинета можно указать несколько адресов, например отдельные адреса для тестовой и рабочей среды. Разным типам событий тоже можно назначить разные обработчики.

  1. Настройте обработчик нужных событий и проверьте его на демо-кабинете.
  2. Передайте команде Консоли название компании, URL обработчиков и названия событий, на которые требуется подписка.
  3. После проверки передайте данные рабочего кабинета и адреса, на которые нужно доставлять уведомления в рабочей среде.

Формат сообщения​

Тело содержит объект details с данными события и объект manifest, в котором action_cipher обозначает тип события:

{
"details": {
"id": 1234
},
"manifest": {
"action_cipher": "workflow.create_tasks"
}
}

Состав details зависит от action_cipher:

СобытияПоля details
Завершение регистрацииid приглашения, name, phone, status, contractor_id, custom_fields, template_fields. Если создан договор, пример статуса — waiting_for_contract_sign; если договор не предусмотрен, возможен completed.
Подписание договораid договора и contractor_id исполнителя.
События заданийОбычно id задания и state_code. Для workflow.finalize_tasks также указан contractor_id.
Выплата по актуtask_id — идентификатор акта, по которому прошла выплата.
Изменение ФИОuser_id, last_name, first_name, patronymic, contractor_id.
Изменение телефонаuser_id, mobile_phone, contractor_id.

Типы событий​

action_cipherКогда приходит уведомление
complete_registrationНовый исполнитель завершил регистрацию.
hiring.complete_registrationУже зарегистрированный исполнитель завершил дополнительный онбординг.
sign_contractИсполнитель подписал договор.
sign_contract_by_allДоговор подписали все требуемые стороны.
workflow.create_tasksСоздано задание.
workflow.accept_tasksЗадание принято.
workflow.confirm_tasksЗадание взято в работу.
workflow.check_in_tasksНачалась работа над заданием.
workflow.check_in_by_contractorИсполнитель подтвердил начало работы.
workflow.complete_taskЗадание завершено.
workflow.check_out_by_contractorИсполнитель подтвердил завершение работы.
workflow.finalize_tasksЗадания завершены с созданием актов.
workflow.update_taskОбновлено задание; событие сейчас отключено для всех компаний.
workflow.decline_tasksПолучен отказ от задания.
workflow.reject_tasksЗадание отклонено.
workflow.revoke_tasksЗадание отозвано.
workflow.delete_tasksУдалено задание; событие сейчас отключено для всех компаний.
workflow.import_tasksИмпортировано задание; событие сейчас отключено для всех компаний.
workflow.seed_tasksЗадание заполнено.
workflow.submit_tasksЗадание размещено.
workflow.auto_confirm_tasksЗадание принято автоматически; событие сейчас отключено для всех компаний.
workflow.confirm_task_reminder_by_contractorИсполнитель подтвердил выход на задание.
workflow.decline_task_reminder_by_contractorИсполнитель отказался выходить на задание.
workflow.ignore_check_in_by_contractorИсполнитель не подтвердил начало задания.
workflow.ignore_task_reminder_by_contractorИсполнитель проигнорировал задание.
tinkoff.payment_succeededВыплата по акту в демо-кабинете.
billing.payment_succeededВыплата по акту в рабочем кабинете с номинальным счётом.
external_bank.payment_succeededВыплата через стороннее платёжное решение отмечена в системе.
fio_changedИзменено ФИО исполнителя; доступно для пользователей, согласованных поддержкой.
mobile_phone_changedИзменён номер телефона исполнителя; доступно для пользователей, согласованных поддержкой.