candidate hired
Essa documentação se refere ao glossário do webhook de dados de contratação para sistema de admissão digital do cliente.
Esse webhook é disparado toda vez que os dados de Pré-Contratação de uma pessoa candidata são preenchidos e salvos após ela ter sido movimentada para a etapa de Contratação. Para ver o contrato JSON desse webhook clique aqui
Mapeamento de campos obrigatórios
Preste atenção aos campos obrigatórios exigidos pelo seu sistema ao desenvolver a integração, pois a pessoa candidata não tem a obrigatoriedade de preencher os dados de endereço ao realizar seu cadastro. Isso significa que alguns campos podem vir "null".
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|---|---|---|
| companyName | Nome da empresa | ||
| id | Não visível | Id do evento | |
| event | Não visível | valor fixo = "candidate.hired" | |
| date | Não visível | Data em que foi salvo o preenchimento dos dados de contratação da pessoa candidata (gatilho para disparo do webhook) | |
| job.id | Número gerado automaticamente pela Gupy ao criar uma vaga (conhecido como jobId). Ao abrir uma vaga na plataforma, o Id pode ser identificado na URL após /companies/jobs/ | Retorno results.id ao criar uma vaga utilizando o endpoint creating a job | |
| job.name | Ao acessar a tela de gestão de vagas, é o nome da vaga em si. | Nome da vaga da em que o candidato foi contratado | |
| job.type | vacancy_type_apprentice vacancy_type_associate vacancy_type_talent_pool vacancy_type_effective vacancy_type_internship vacancy_type_summer vacancy_type_temporary vacancy_type_outsource vacancy_type_trainee vacancy_type_volunteer vacancy_legal_entity vacancy_type_lecturer vacancy_type_freelancer vacancy_type_autonomous | Ao acessar a tela de gestão de vagas e identificar a vaga, ao consultar as informações da vaga em, Ver Resumo -> Detalhes da vaga é o campo Tipo | |
| job.departmentCode | Não visível | Código da área da vaga em que a pessoa candidata foi contratada | |
| job.roleCode | Não visível | Código do cargo da vaga em que a pessoa candidata foi contratada | |
| job.branchCode | Não visível | Código da filial da vaga em que a pessoa candidata foi contratada | |
| job.customFields[] | Em resumo da vaga, na seção Dados adicionais | Campos customizados e seus respectivos tipos e opções (se houver) | |
| department.id | Não visível | Código da área. Número gerado automaticamente pela Gupy ao criar uma área. | |
| department.code | Não visível | Código definido pelo cliente (normalmente corresponde ao código da área no sistema que vai ser integrado com a Gupy). Esse campo só pode ser preenchido através da API Creating a department | |
| department.name | Em resumo da vaga, na seção Detalhes da vaga | Nome da área | |
| department.similarity | No setup de áreas | Similaridade da área | |
| role.id | Não visível | Código do cargo. Número gerado automaticamente pela Gupy ao criar um cargo. | |
| role.code | Não visível | Código definido pelo cliente (normalmente corresponde ao código do cargo no sistema que vai ser integrado com a Gupy). Esse campo só pode ser preenchido através da API Creating a role | |
| role.name | Em resumo da vaga, na seção Detalhes da vaga | Nome do cargo | |
| role.similarity | No setup de cargos | Similaridade do cargo | |
| branch.id | Não visível | Código da filial. Número gerado automaticamente pela Gupy ao criar uma filial. | |
| branch.code | Não visível | Código definido pelo cliente (normalmente corresponde ao código da filial no sistema que vai ser integrado com a Gupy). Esse campo só pode ser preenchido através da API Creating branches . Cada filial deve ter o seu próprio code. | |
| branch.name | Em resumo da vaga, na seção Local de trabalho | Nome da filial/estrutura organizacional | |
| application.id | Número gerado automaticamente pela Gupy quando uma pessoa se candidata em uma determinada vaga. O Id aparece na URL após /jobs/jobId/candidates | Retorno results.id ao criar uma candidatura utilizando o endpoint creating an application | |
| application.vacancyCode | Dados da contratação | Código de posição que foi atribuído ao candidato no momento em que ele foi contratado | |
| application.score | Na lista de candidatos em uma vaga é a porcentagem antes do nome do candidato e ao acessar uma candidatura, na tela principal é o valor definido para "Afinidade" | Aderência do candidato à vaga | |
| application.partnerName | 99hunters, catho, facebook_jobs, geekhunter, glassdoor, google_for_jobs, indeed, indeed_sponsored, jooble, linkedin, netvagas, riovagas, trampos, gupy_opportunities, gupy_opportunities_recommended, gupy_public_page, gupy_public_page_event | Nome do parceiro que gerou a candidatura. Em casos de inserção manual, essa informação só é preenchida após o candidato aceitar o convite. | |
| application.tags | Ao acessar uma candidatura, menu de Avaliação do Candidato no lado direito da tela | Tags relacionadas à candidatura, se houverem. | |
| application.hiringDate | Dados da contratação | É um campo preenchido nos dados de Pré-Contratação | |
| application.hiringType | employee_admission, employee_readmission, employee_reintegration, unrelated_worker_hiring, internal_transfer | Dados da contratação | É um campo preenchido nos dados de Pré-Contratação |
| application. currentStep.id | Ao editar uma etapa, o seu Id aparecerá na URL. Como nesse caso a pessoa candidata sempre estará na etapa padrão de Contratação o Id estará ao final da URL logo após /step/final | ||
| application. currentStep.name | Na lista de candidatos em uma vaga, o nome da etapa está logo abaixo do nome do candidato e ao abrir uma candidatura, tela principal do candidato, logo abaixo do nome. | Nome da etapa em que o candidato está no momento do disparo do webhook (nesse caso sempre será "Contratação") | |
| application. currentStep.type | register: etapa de cadastro online: etapa customizada quando há alguma ação automática (teste, envio de vídeos, disparo de e-mail) offline: etapa customizada que há algum tipo de ação fora da plataforma (entrevista, agendamentos) | Não visível | Nesse caso sempre será o valor "final" |
| application. salary.currency | R$, U$ | Em resumo da vaga, na seção Detalhes da vaga | Identificação da moeda |
| application. salary.value | Em resumo da vaga, na seção Detalhes da vaga | Salário, composto pela faixa salarial | |
| candidate.id | Não visível | Id do candidato, gerado na primeira vez em que ele se inscreve em alguma vaga na Gupy. | |
| candidate.name | Ao acessar uma candidatura, aba Cadastro | Nome do candidato | |
| candidate.lastName | Ao acessar uma candidatura, aba Cadastro | Sobrenome do candidato | |
| candidate.email | Ao acessar uma candidatura, aba Cadastro | E-mail do candidato | |
| candidate. identificationDocument | Ao acessar uma candidatura, aba Cadastro | CPF do candidato | |
| candidate. countryOfOrigin | Por extenso: Brasil | Ao acessar uma candidatura, aba Cadastro | País de origem do candidato |
| candidate.birthdate | Formato de data utilizado pela Gupy: YYYY-MM-DD | Ao acessar uma candidatura, aba Cadastro | Data de aniversário do candidato |
| candidate. addressZipCode | Ao acessar uma candidatura, aba Cadastro | CEP da residência do candidato. | |
| candidate. addressNumber | Ao acessar uma candidatura, aba Cadastro | Número da residência do candidato. | |
| candidate. addressStreet | Ao acessar uma candidatura, aba Cadastro | Logradouro da residência do candidato. | |
| candidate. addressCity | Ao acessar uma candidatura, aba Cadastro | Cidade da residência do candidato. | |
| candidate. addressState | Ao acessar uma candidatura, aba Cadastro | Estado da residência do candidato. | |
| candidate. addressStateShortName | Ao acessar uma candidatura, aba Cadastro | Abreviação com 2 dígitos (sigla) do Estado em que o candidato reside. | |
| candidate. addressCountry | Ao acessar uma candidatura, aba Cadastro | País de residência do candidato. | |
| candidate. addressCountryShortName | Ex: BR | Ao acessar uma candidatura, aba Cadastro | Abreviação com 2 dígitos (sigla) do nome do país em que o candidato reside. |
| candidate. mobileNumber | Ao acessar uma candidatura, aba Cadastro | Telefone celular do candidato | |
| candidate. phoneNumber | Ao acessar uma candidatura, aba Cadastro | Telefone fixo do candidato | |
| candidate.schooling | elementary_school, high_school, technical_course, technological, graduation, post_graduate, master_degree, phd | Ao acessar uma candidatura na tela principal | Nível escolar do candidato |
| candidate. schoolingStatus | complete, in_progress, incomplete | Ao acessar uma candidatura na tela principal | Status de andamento do nível escolar informado |
| candidate.disabilities | true, false | Ao abrir uma candidatura, tela principal do candidato em Diversidade | Caso o candidato tenha informado possuir alguma deficiência esse campo vem true, caso contrário, false. |
| candidate.gender | male, female, other, notInformed | Ao acessar uma candidatura, aba Cadastro | Gênero do candidato |
| user.id | Não visível | Id do usuário que moveu a pessoa para Contratação | |
| user.name | Em setup -> Acesso à plataforma -> Usuários | Nome do usuário que moveu a pessoa para Contratação | |
| user.email | Em setup -> Acesso à plataforma -> Usuários | e-mail do usuário que moveu a pessoa para Contratação | |
| user.code | Não visível | Code do usuário que moveu a pessoa para Contratação |
Updated over 1 year ago