События и поля

HRlink отправляет на настроенный обработчик JSON-массив событий. В массиве всегда есть хотя бы одно событие. Действующий максимальный размер — 1000 событий.

Сначала выберите нужный eventType в обзорной таблице. Затем перейдите к его разделу, чтобы посмотреть поля и полный пример JSON.

Как читать описание

• payload — данные конкретного события. Их состав зависит от eventType.
• correlationId — идентификатор задачи или документа, с которым связано событие.
• UUID — идентификатор объекта, например 6ba5818b-6df0-451a-b45f-040359d6fdad.
• object — JSON-объект в фигурных скобках {}.
• array — JSON-массив в квадратных скобках [].
• date-time — дата и время в формате ISO 8601, например 2026-07-16T09:41:30Z.

В таблицах «допускает null» означает, что поле может иметь значение JSON null. Некоторые необязательные поля могут не войти в JSON. Чтобы обработчик не зависел от способа передачи пустого значения, принимайте оба варианта: ключ отсутствует или передан со значением null.

События в одном списке

Событие	Что произошло	Что обычно делает ваша система
CREATED_DOCUMENT_AND_SEND_TO_SIGNING_TASK	Создана или изменилась задача групповой отправки	Обновляет состояние задачи и результаты создания документов
DOCUMENT_SENT_TO_SIGNING	Документ отправлен по маршруту подписания	Сохраняет состояние документа после отправки
DOCUMENT_DOCFLOW_PARTICIPANT_STATE_CHANGED	Участник просмотрел, подписал или отклонил документ	Обновляет состояние участника и документа
DOCUMENT_PRINT_FORM_UPDATED	Изменилась печатная формапечатная формаPDF-документ с визуальным оттиском подписей, который система формирует после завершения документооборота. Печатная форма доступна для скачивания и используется для архивного хранения. документа	При необходимости получает новую печатную формупечатная формаPDF-документ с визуальным оттиском подписей, который система формирует после завершения документооборота. Печатная форма доступна для скачивания и используется для архивного хранения. через API

Как запросить новый тип события

Если в справочнике нет нужного типа события, отправьте персональному менеджеру HRlink запрос на доработку. Опишите, что должно происходить в HRlink, какой тип события нужен вашей системе и какие данные должно содержать событие.

Новый тип события нельзя добавить настройкой существующей подписки. Запрос на доработку не означает, что HRlink добавит новый тип события, и не задаёт срок его добавления.

Общая оболочка

Поле	Тип	Обязательно	Описание
id	UUID	да	Идентификатор события. Используйте его, чтобы распознать повтор
clientId	UUID	нет	Идентификатор клиента. Поле может отсутствовать, если событие не связано с клиентом
eventDate	string (date-time)	да	Время бизнес-события в UTC
eventType	string	да	Тип события
payload	object	да	Данные конкретного события
correlationId	UUID	да	Идентификатор документа или задачи

tenantId не входит в JSON. ТенантTenantЭкземпляр системы HRlink на отдельном домене (например, company.hr-link.ru). Внутри одного тенанта может быть несколько пространств клиентов. определён самой подпиской.

Значение correlationId зависит от события:

eventType	Когда HRlink создаёт событие	correlationId
CREATED_DOCUMENT_AND_SEND_TO_SIGNING_TASK	Создание или изменение задачи групповой отправки	IDidВнутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. задачи
DOCUMENT_SENT_TO_SIGNING	Документ отправлен по маршруту подписания	IDidВнутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. документа
DOCUMENT_DOCFLOW_PARTICIPANT_STATE_CHANGED	Подписант или наблюдатель выполнил действие	IDidВнутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. документа
DOCUMENT_PRINT_FORM_UPDATED	Обновилась печатная формапечатная формаPDF-документ с визуальным оттиском подписей, который система формирует после завершения документооборота. Печатная форма доступна для скачивания и используется для архивного хранения. документа	IDidВнутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. документа

Базовый документ

Внешний объект baseDocument допускает null. Если объект присутствует, он содержит:

Поле	Тип	Допускает null
id	UUID	нет
externalId	string	да

CREATED_DOCUMENT_AND_SEND_TO_SIGNING_TASK

Метод Создать группу и отправить на подписание создаёт задачу групповой отправки. HRlink отправляет событие при создании задачи и при последующих изменениях.

Используйте payload.task, чтобы обновить состояние задачи, результаты конвертации, список документов задачи и результаты их создания.

Поле	Тип	Допускает null	Описание
id	UUID	нет	IDidВнутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. задачи
state	string	нет	Текущее состояние задачи
createdDate	string (date-time)	нет	Время создания
finishedDate	string (date-time)	да	Время завершения
failReason	string	да	Причина ошибки
conversionStatuses	array	да	Результаты конвертации файлов
documents	array	да	Первые 1000 документов задачи

Значения state:

Значение	Описание
CREATED	Задача создана
FILES_CONVERSION_PENDING	HRlink конвертирует файлы
FILES_CONVERTED	Файлы сконвертированы
FINISHED	Документы созданы и отправлены
FAILED	Выполнение завершилось ошибкой
USER_NOTIFIED_ABOUT_FAIL	HRlink уведомил создателя задачи об ошибке

Значения failReason:

Значение	Описание
CONVERSION_TO_PDFA_FAILED	Не удалось преобразовать файл в PDF/A
DOCUMENT_NO_LONGER_HAVE_UNIQUE_EXTERNAL_ID	externalId занял другой документ во время выполнения
EKD_CALENDAR_ERROR	HRlink не рассчитал срок по календарю
EMPLOYEE_DONT_HAVE_CALENDAR	Для сотрудника нет календаря на нужный год

Вложенные объекты:

• conversionStatuses[]: обязательные fileId (UUID) и status (CONVERTED или FAILED);
• documents[]: поля id, externalId, baseDocument и version допускают null;
• documents[].baseDocument: внешний объект допускает null; если объект присутствует, используйте модель Базовый документ.

До создания документа поля id, baseDocument и version могут содержать null. Не считайте такой элемент подтверждением создания документа: проверьте state задачи и наличие id.

[
  {
    "id": "e165a7d5-e2f3-47f9-8a8b-5cfaa32dbdd9",
    "clientId": "f73fd3ee-89f6-45a2-a90d-fc48f615c4ef",
    "eventDate": "2026-07-16T09:40:00Z",
    "eventType": "CREATED_DOCUMENT_AND_SEND_TO_SIGNING_TASK",
    "payload": {
      "task": {
        "id": "4df97a49-538a-4942-b4f0-bd80a7576c80",
        "state": "FINISHED",
        "createdDate": "2026-07-16T09:39:10Z",
        "finishedDate": "2026-07-16T09:40:00Z",
        "failReason": null,
        "conversionStatuses": [
          {
            "fileId": "e516fbb7-b38f-464e-9886-c2ab7ff1eb09",
            "status": "CONVERTED"
          }
        ],
        "documents": [
          {
            "id": "6ba5818b-6df0-451a-b45f-040359d6fdad",
            "externalId": "DOC-2026-0042",
            "baseDocument": {
              "id": "98c5788e-875e-4145-8c85-96f4ef62dc17",
              "externalId": "DRAFT-2026-0042"
            },
            "version": 1
          }
        ]
      }
    },
    "correlationId": "4df97a49-538a-4942-b4f0-bd80a7576c80"
  }
]

payload.task.documents содержит первые 1000 документов задачи. Если документов больше, остальные не входят в это событие. Ограничение относится к списку документов внутри одного события, а не к количеству событий в HTTP-запросе.

Это действующее ограничение. HRlink может изменить его без отдельного уведомления и отразит новое значение в документации.

Снимок документа

События DOCUMENT_SENT_TO_SIGNING и DOCUMENT_DOCFLOW_PARTICIPANT_STATE_CHANGED используют одинаковый payload.document.

Поле	Тип	Допускает null	Описание
id	UUID	нет	IDidВнутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. документа
version	integer (int64)	нет	Версия документа
externalId	string	да	Внешний IDexternalIdВнешний идентификатор сущности — произвольная строка, задаваемая интегратором при создании. Связывает сущность HRlink с записью во внешней системе (1С, SAP и др.) без хранения маппинга UUID. документа
baseDocument	object	да	Модель Базовый документ
draft	boolean	нет	Документ — черновик
deleted	boolean	нет	Документ удалён
signed	boolean	нет	Документ подписан
rejected	boolean	нет	Документ отклонён
convertedFileId	UUID	да	IDidВнутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. файла PDF/A
createdDate	string (date-time)	нет	Время создания
sentDate	string (date-time)	да	Время отправки на подписание
docflowFinishedDate	string (date-time)	да	Время завершения документооборота
lastSignedDate	string (date-time)	да	Время последней подписи
signingOrder	string	да	MANAGER_FIRST, EMPLOYEE_FIRST, EMPLOYEE_ONLY, MANAGER_ONLY или ROUTE
statusLastModifiedDate	string (date-time)	да	Время последнего изменения статуса
headManager	object	да	Руководитель-подписант
employees	array	нет	Сотрудники-подписанты
watchers	array	нет	Наблюдатели
participants	array	нет	Участники маршрута
route	object	да	Модель Маршрут

Маршрут

Внешний объект route допускает null. Если объект присутствует, он содержит:

Поле	Тип	Допускает null
key	string	нет

Поля подписанта в headManager, employees[] и participants[]:

Поле	Тип	Допускает null
id	UUID	нет
employeeId	UUID	нет
externalId	string	да
signerType	string	нет
signingAvailabilityDate	string (date-time)	да
seenDate	string (date-time)	да
madeDecision	boolean	нет
signedDate	string (date-time)	да
signingOrder	integer (int64)	нет
rejectedDate	string (date-time)	да
rejectionComment	string	да

signerType принимает значения HEAD_MANAGER, EMPLOYEE и PARTICIPANT.

Поля наблюдателя в watchers[]:

Поле	Тип	Допускает null
id	UUID	нет
employeeId	UUID	нет
externalId	string	да
seenDate	string (date-time)	да

DOCUMENT_SENT_TO_SIGNING

HRlink создаёт событие после отправки документа по маршруту подписания. Сохраните состояние из payload.document; его поля описаны в разделе Снимок документа.

[
  {
    "id": "32387617-352d-4c01-861a-fac566f584ab",
    "clientId": "f73fd3ee-89f6-45a2-a90d-fc48f615c4ef",
    "eventDate": "2026-07-16T09:40:30Z",
    "eventType": "DOCUMENT_SENT_TO_SIGNING",
    "payload": {
      "document": {
        "id": "6ba5818b-6df0-451a-b45f-040359d6fdad",
        "version": 1,
        "externalId": "DOC-2026-0042",
        "baseDocument": {
          "id": "98c5788e-875e-4145-8c85-96f4ef62dc17",
          "externalId": "DRAFT-2026-0042"
        },
        "draft": false,
        "deleted": false,
        "signed": false,
        "rejected": false,
        "convertedFileId": "8ac7f546-354e-4a55-8666-32602ee35447",
        "createdDate": "2026-07-16T09:40:20Z",
        "sentDate": "2026-07-16T09:40:30Z",
        "docflowFinishedDate": null,
        "lastSignedDate": null,
        "signingOrder": "ROUTE",
        "statusLastModifiedDate": "2026-07-16T09:40:30Z",
        "headManager": null,
        "employees": [
          {
            "id": "53fe8d5f-cbac-4e0e-9701-9fc2d263427f",
            "employeeId": "15c2ac3e-896f-4de4-982b-7be8aaeea198",
            "externalId": "EMP-0042",
            "signerType": "EMPLOYEE",
            "signingAvailabilityDate": "2026-07-16T09:40:30Z",
            "seenDate": null,
            "madeDecision": false,
            "signedDate": null,
            "signingOrder": 0,
            "rejectedDate": null,
            "rejectionComment": null
          }
        ],
        "watchers": [],
        "participants": [],
        "route": {
          "key": "EMPLOYEE_THEN_HR"
        }
      }
    },
    "correlationId": "6ba5818b-6df0-451a-b45f-040359d6fdad"
  }
]

DOCUMENT_DOCFLOW_PARTICIPANT_STATE_CHANGED

HRlink создаёт событие после действия подписанта или наблюдателя. Обновите данные участника по payload.docflowParticipant, а состояние документа — по payload.document.

payload.docflowParticipant содержит:

Поле	Тип	Значения
id	UUID	IDidВнутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. записи подписанта или наблюдателя
type	string	HEAD_MANAGER, EMPLOYEE, WATCHER, PARTICIPANT
action	string	SEEN, SIGN, REJECTED

SEEN — просмотр, SIGN — подписание, REJECTED — отклонение. payload.document содержит снимок после действия.

[
  {
    "id": "9feaf975-5796-446a-aef3-59f72f08b993",
    "clientId": "f73fd3ee-89f6-45a2-a90d-fc48f615c4ef",
    "eventDate": "2026-07-16T09:41:22Z",
    "eventType": "DOCUMENT_DOCFLOW_PARTICIPANT_STATE_CHANGED",
    "payload": {
      "docflowParticipant": {
        "id": "53fe8d5f-cbac-4e0e-9701-9fc2d263427f",
        "type": "EMPLOYEE",
        "action": "SIGN"
      },
      "document": {
        "id": "6ba5818b-6df0-451a-b45f-040359d6fdad",
        "version": 2,
        "externalId": "DOC-2026-0042",
        "baseDocument": {
          "id": "98c5788e-875e-4145-8c85-96f4ef62dc17",
          "externalId": "DRAFT-2026-0042"
        },
        "draft": false,
        "deleted": false,
        "signed": true,
        "rejected": false,
        "convertedFileId": "8ac7f546-354e-4a55-8666-32602ee35447",
        "createdDate": "2026-07-16T09:40:20Z",
        "sentDate": "2026-07-16T09:40:30Z",
        "docflowFinishedDate": "2026-07-16T09:41:22Z",
        "lastSignedDate": "2026-07-16T09:41:22Z",
        "signingOrder": "EMPLOYEE_ONLY",
        "statusLastModifiedDate": "2026-07-16T09:41:22Z",
        "headManager": null,
        "employees": [
          {
            "id": "53fe8d5f-cbac-4e0e-9701-9fc2d263427f",
            "employeeId": "15c2ac3e-896f-4de4-982b-7be8aaeea198",
            "externalId": "EMP-0042",
            "signerType": "EMPLOYEE",
            "signingAvailabilityDate": "2026-07-16T09:40:30Z",
            "seenDate": "2026-07-16T09:41:00Z",
            "madeDecision": true,
            "signedDate": "2026-07-16T09:41:22Z",
            "signingOrder": 0,
            "rejectedDate": null,
            "rejectionComment": null
          }
        ],
        "watchers": [],
        "participants": [],
        "route": null
      }
    },
    "correlationId": "6ba5818b-6df0-451a-b45f-040359d6fdad"
  }
]

DOCUMENT_PRINT_FORM_UPDATED

HRlink создаёт событие после обновления печатной формыпечатная формаPDF-документ с визуальным оттиском подписей, который система формирует после завершения документооборота. Печатная форма доступна для скачивания и используется для архивного хранения. документа. Если вашей системе нужен новый файл, получите его методом Получить печатную форму документа.

Поле	Тип	Допускает null	Описание
id	UUID	нет	IDidВнутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. документа
externalId	string	да	Внешний IDexternalIdВнешний идентификатор сущности — произвольная строка, задаваемая интегратором при создании. Связывает сущность HRlink с записью во внешней системе (1С, SAP и др.) без хранения маппинга UUID.
baseDocument	object	да	Модель Базовый документ
version	integer (int64)	нет	Версия документа
printFormUpdatedDate	string (date-time)	да	Время обновления печатной формыпечатная формаPDF-документ с визуальным оттиском подписей, который система формирует после завершения документооборота. Печатная форма доступна для скачивания и используется для архивного хранения.

Последний участник документооборота

Внешний объект payload.printFormLastDocflowParticipant допускает null. Если объект присутствует, он содержит:

Поле	Тип	Допускает null
id	UUID	нет
type	string	нет

Объект printFormLastDocflowParticipant содержит подписанта, чьё действие инициировало обновление печатной формыпечатная формаPDF-документ с визуальным оттиском подписей, который система формирует после завершения документооборота. Печатная форма доступна для скачивания и используется для архивного хранения.. Если обновление не связано с подписантом, значение payload.printFormLastDocflowParticipant — null.

Поле type принимает значения HEAD_MANAGER, EMPLOYEE и PARTICIPANT.

[
  {
    "id": "792bd744-a159-467a-9665-3f2943a2d7d3",
    "clientId": "f73fd3ee-89f6-45a2-a90d-fc48f615c4ef",
    "eventDate": "2026-07-16T09:41:30Z",
    "eventType": "DOCUMENT_PRINT_FORM_UPDATED",
    "payload": {
      "document": {
        "id": "6ba5818b-6df0-451a-b45f-040359d6fdad",
        "externalId": "DOC-2026-0042",
        "baseDocument": {
          "id": "98c5788e-875e-4145-8c85-96f4ef62dc17",
          "externalId": "DRAFT-2026-0042"
        },
        "version": 2,
        "printFormUpdatedDate": "2026-07-16T09:41:30Z"
      },
      "printFormLastDocflowParticipant": {
        "id": "53fe8d5f-cbac-4e0e-9701-9fc2d263427f",
        "type": "EMPLOYEE"
      }
    },
    "correlationId": "6ba5818b-6df0-451a-b45f-040359d6fdad"
  }
]