Webhook
Webhook позволяет получать уведомления о событиях Консоль.HRM без постоянного опроса API.
Приём уведомлений
Подготовьте общедоступный адрес, принимающий POST. Этот адрес должен принимать входящие уведомления без аутентификации и отвечать любым HTTP-кодом группы 2xx после обработки. Такой ответ подтверждает доставку события.
Уведомления могут приходить с IP-адресов:
84.201.153.160158.160.48.19884.201.153.101158.160.170.215
Если получатель ответит не кодом 2xx, предусмотрено 20 попыток отправки с постепенно увеличивающимися интервалами. Обработчик должен корректно переносить повторную доставку одного и того же события.
Подключение
Для одного кабинета можно указать несколько адресов, например отдельные адреса для тестовой и рабочей среды. Разным типам событий тоже можно назначить разные обработчики.
- Настройте обработчик нужных событий и проверьте его на демо-кабинете.
- Передайте команде Консоли название компании, URL обработчиков и названия событий, на которые требуется подписка.
- После проверки передайте данные рабочего кабинета и адреса, на которые нужно доставлять уведомления в рабочей среде.
Формат сообщения
Тело содержит объект 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 | Изменён номер телефона исполнителя; доступно для пользователей, согласованных поддержкой. |