Описание атрибутов вебхука

[aleksandrnikishov]

Добрый день.

• документация: https://github.com/huntflow/api/blob/master/ru/webhooks.md#event-types

Необходимо корректное описание атрибутов вебхука по событиям:
Событие "SURVEY-QUESTIONARY":

Шаблон анкеты (survey_questionary.survey):
1.1 - name
1.2. Схема данных анкеты (survey_questionary.survey.schema) - по всем атрибутам
1.3. Схема визуального отображения анкеты (survey_questionary.survey.ui_schema) - по всем атрибутам

Анкета кандидата (survey_questionary)
2.1. (survey_questionary.respondent) - по всем атрибутам
2.2. (survey_questionary.created_by) - по всем атрибутам
2.3. (survey_questionary.answer) - по всем атрибутам
2.4. (survey_questionary.answer.data) - по всем атрибутам

Событие "VACANCY":

Вакансия (vacancy):
multiple
parent
Событие "APPLICANT":

Респондент (applicant_log.survey_answer_of_type_a.respondent):
custom_id
Участники встречи, назначенной в календаре (applicant_log.calendar_event.attendees):
member
order
resource
name
Назначенная встреча в календаре (applicant_log.calendar_event)
interview_type
state
transparency
vacancy_group_action
recurrence
Кандидат (applicant.values) - по всем атрибутам
(event_applicant):
position
(event_applicant_social):
value
Событие "RESPONSE"
(applicant_external_response):
data (описание атрибутов внутри объекта)
resume (описание атрибутов внутри объекта)
(vacancy_external):
created
data (описание атрибута)

[KlochkovHF]

Добрый день! Собрали для вас ответ:

SURVEY_QUESTIONARY

SURVEY_QUESTIONARY.SURVEY

• survey_questionary.survey.name - Название анкеты - str
  survey_questionary.survey.schema
• schema.type - тип схемы (type_a/type_q)
• schema.required - Список ключей вопросов обязательных для заполнения
• schema.properties - Объект содержащий объекты с данными о вопросах
• schema.properties.ANY-KEY. - Объект данных вопроса
• schema.properties.ANY-KEY.type - Тип поля
• schema.properties.ANY-KEY.title - Текст вопроса
• schema.properties.ANY-KEY.metadata - Объект содержащий метаданные вопроса
• schema.properties.ANY-KEY.metadata.files - Список прикрепленных файлов
• schema.properties.ANY-KEY.metadata.files[0] - Объект содержащий данные о прикрепленном файле (id, name, content_type, url)

{
  "schema": {
    "type": "object",
    "required": [
      "DTlJoF1fDHpKLwDLoFVTy"
    ],
    "properties": {
      "DTlJoF1fDHpKLwDLoFVTy": {
        "type": "string",
        "title": "question1?",
        "metadata": {
          "files": [
            {
              "id": 67,
              "name": "Makefile",
              "content_type": "text/plain",
              "url": "https://domain/path/to/file"
            }
          ]
        },
        "isNotEmpty": true
      },
      "xWZlBE6vLTB4p33ii54NA": {
        "enum": [
          "2Q31yAnRRa__E4x8frS-O",
          "me_LYnlcNu5qyS25bcDqZ",
          "O5PtMkfRtNV0eDmHqnjjX"
        ],
        "type": "string",
        "title": "question2?"
      }
    },
    "additionalProperties": false
  }
}

survey_questionary.survey.ui_schema - схема используемая для отображения анкеты (Не несет полезной информации для клиента)
survey_questionary.survey.type - str (Всегда type_q)

SURVEY_QUESTIONARY.RESPONDENT

• respondent.applicant_id - ID кандидата, которому была отправлена анкета,
• respondent.name: - ФИО кандидата, которому была отправлена анкета

SURVEY_QUESTIONARY.CREATED_BY

• account_id - ID сотрудника отправившего анкету
• name - Имя сотрудника отправившего анкету

SURVEY_QUESTIONARY.ANSWER - Данные ответа кандидата

• id - ID ответа кандидата
• created - Дата и время заполнения анкеты
• link - Ссылка на прохождение анкеты (после прохождения получить доступ не получится)
• data - Данные ответов кандидата
  Объект содержаший ключи, соответствующие ключам объектов из survey.schema.properties.
  В зависимости от вида вопроса, ответ может быть строкой, числом, списком строк или объектом аналогичным schema.properties.ANY-KEY.metadata.files[0]

{
  "data": {
    "DTlJoF1fDHpKLwDLoFVTy": "1",
    "igU2KgQfPo5pRQ345sFpg": [
      {
        "id": 67,
        "name": "Makefile",
        "content_type": "text/plain",
        "url": "https://domain/path/to/file"
      }
    ],
    "xWZlBE6vLTB4p33ii54NA": "2Q31yAnRRa__E4x8frS-O"
  }
}

VACANCY

• vacancy.multiple - Булевый флаг указывающий на то является ли вакансия мультивакансией
• vacancy.parent - К дочерним вакансиям в мультивакансии - ID вакансии-родителя

APPLICANT

applicant_log.calendar_event

• calendar_event.interview_type - Объект тип интервью
• calendar_event.interview_type.id - ID типа интервью
• calendar_event.interview_type.name - Название типа интервью
• calendar_event.state - статус события
• calendar_event.transparency - Доступность события - возможные значения busy | free

applicant_log.calendar_event.attendees

• attendees[0].member - id пользователя
• attendees[0].order - Порядок участника во встрече
• attendees[0].name - Имя участника встречи str

applicant

• applicant.position - Текущая должность кандидата str | None

applicant.social - Список объектов социальных сетей кандидата

• applicant.social[0].id - ID записи с информацией о социальных сетях кандидата
• applicant.social[0].type - Название социальной сети/мессенджера
• applicant.social[0].value - имя пользователя в соц. сети/мессенджере
• applicant.social[0].verified - Флаг верификации записи
• applicant.social[0].verification_date - Дата и время верификации записи

applicant.values - Объект содержащий дополнительную информацию о кандидате.
Поля зависят от схемы https://api.huntflow.ru/v2/docs#get-/accounts/-account_id-/applicants/questionary

RESPONSE

applicant_external_response

• applicant_external_response.data - Сырые данные полученные с карьерного сайта
• applicant_external_response.resume - Формат данных не зафиксирован и может произвольно меняться

response.vacancy_external

• created - Дата и время публикации вакансии
• data - Позиция вакансии

[aleksandrnikishov]

Добрый день. Отсутствуют Типы и описания следующих атрибутов:
(applicant_log.calendar_event.attendees):
-resource
(applicant_log.survey_answer_of_type_a.respondent):
-custom_id
-vacancy_group_action

Также хотелось бы уточнить, applicant.position - Текущая должность кандидата str | None - в данном ключе передается значение должности на которую кандидат рассматривается или должность на прежнем месте работы?

[KlochkovHF]

Добрый день.
applicant.position - Текущая должность кандидата (На которой работает в данный момент)
applicant_log .calendaer_event.attendees.resource - Флаг указывающий - является ли участник человеком или ресурсом (принтер, ксерокс и тд)
applicant_log.survey_answer_of_type_a.respondent.custom_id - всегда null
applicant_log.calendar_event.vacancy_group_action - этого поля уже нет в системе