Fluxo de Admissão da Pessoa Contratada
Esse fluxo é destinado ao envio de dados das candidaturas que chegaram à fase final de Contratação nas vagas do R&S Gupy para um sistema de onboarding/admissão utilizado pela sua empresa.
A partir desse envio é possível receber retorno do sistema e adicioná-lo - em forma de "tag"- ou comentário na timeline para registro de status final ou informação relevante da conclusão do processo.
Este fluxo utiliza webhook
Para implementar integrações a partir de webhooks é necessário uma configuração prévia através da própria API Gupy: Veja aqui mais informações sobre o recebimento de webhooks
Atenção!
A URL usada para receber o webhook DEVE ser um endereço HTTPS válido, exposto publicamente. Para configurar o webhook, consulte Webhook Configuração .
URLs com alta taxa de erro (100% dos erros nos últimos 7 dias) serão removidas sem aviso prévio.
O sistema garante pelo menos uma entrega, então podem haver várias notificações do mesmo evento, use a propriedade id para identificar duplicatas.
Não há garantia de ordem de entrega, use a propriedade date para verificar qual evento aconteceu primeiro e classifique os eventos. Exemplo: um application.moved pode ser notificado antes de application.created
NÃO USE serviços como requestcatcher, eles podem expor dados.
Habilitando Endpoints
Para utilizar este fluxo, é necessário utilizar o Bearer Token gerado nas configurações avançadas da plataforma. Acesse nossa seção de autenticação para saber como gerar o token de autenticação.
Abaixo encontra-se uma sugestão dos endpoints que devem ser habilitados obrigatoriamente para o funcionamento perfeito deste fluxo.
Fluxo de integração
Configurar webhook Candidate Hired Event
- Acessar endpoint POST Webhooks (https://developers.gupy.io/reference/createwebhook)
- Ajustar o parâmetro "action" para candidate.hired
- Inserir no "postbackUrl" o endereço (URL segura) para onde será direcionado o webhook
- Inserir o Bearer token e então no botão "Try it!"
Exemplo de requisição
curl --request POST \
--url https://api.gupy.io/api/v1/webhooks \
--header 'accept: application/json' \
--header 'authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
--header 'content-type: application/json' \
--data '
{
"action": "candidate.hired",
"status": "active",
"postbackUrl": "https://urldo.agenteintegrador.net",
"techOwnerName": "Nome Sobrenome",
"techOwnerEmail": "[email protected]"
}
'
Exemplo de resposta para um webhook cadastrado com sucesso
{
"id": "d5b2eca6-09c5-4014-9eb8-1d729dd2e3d6",
"action": "application.completed",
"postbackUrl": "https://urldo.agenteintegrador.net",
"status": "active"
}
Recebimento no agente integrador
O evento será disparado quando esses dois requisitos forem cumpridos:
- Pessoa candidata for movida para a etapa de contratação (ultima etapa padrão nas vagas);
- As informações de contratação que aparecerem na tela de dados de contratação forem preenchidas pela pessoa recrutadora.
O agente integrador receberá os dados webhook (conforme contrato-JSON candidate hired)
Atenção!
O exemplo utilizado acima trata-se de um webhook modelo e não é indicado trabalhar o desenvolvimento a partir do mesmo. O ideal é que o desenvolvimento seja a partir de um payload real.
Para consultar como obter payloads reais, clique aqui.
Inserindo retorno como TAG
Envie requisição para o endpoint PUT tags
Exemplo de requisição
curl --request PUT \
--url https://api.gupy.io/api/v1/jobs/123456/applications/654321/tags \
--header 'accept: application/json' \
--header 'authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
--header 'content-type: application/json' \
--data '{"name":"Contratado"}'
Exemplo de resposta
{
"id": 34486644,
"candidateId": 33172137,
"applicationId": 654321,
"jobId": 123456,
"name": "Contratado"
}
Inserindo retorno como comentário na timeline
Envie requisição para o endpoint Creating a comment in candidate timeline
Exemplo de requisição
curl --request POST \
--url https://api.gupy.io/api/v1/jobs/269691/applications/33428140/comments \
--header 'accept: application/json' \
--header 'authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
--header 'content-type: application/json' \
--data '
{
"text": "O candidato foi contratado para a posição de Engenheiro de Software"
}
'
Exemplo de resposta
{
"id": 12307223,
"userId": 22011,
"hidden": false,
"text": "O candidato foi contratado para a posição de Engenheiro de Software",
"createdAt": "2023-05-13T10:24:26.838Z",
"updatedAt": "2023-05-13T10:24:26.838Z"
}
Mapeamento de campos
Alguns campos enviados pela Gupy no webhook são na verdade uma lista de opções, abaixo trazemos todas as opções possíveis de valores para um determinado campo afim de auxiliá-los a realizar o mapeamento de/para da integração Gupy x Sistema Terceiro
CAMPO | Opções da lista para DE/PARA | Observações |
---|---|---|
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_type_entity, vacancy_type_lecturer, vacancy_type_freelancer, vacancy_type_autonomous | |
schooling | elementary_school, high_school, technical_course, graduation, technological, post_graduate, master_degree, phd, post_doctorate | Normalmente ocorre a concatenação dos campos schooling e schoolingStatus formando uma string única como por exemplo: "elementary_school_complete" para realizar o DE/PARA de informações |
schoolingStatus | complete, incomplete, in_progress | |
gender | Male, Female, Other, NotInformed |
Possíveis erros
Recebimento no agente integrador
O ambiente precisa estar público para poder receber os dados, caso contrário, acontecerá um erro.
Informações obrigatórias faltantes
Pode ser que o sistema de admissão/onboarding utilizado pela sua empresa requer com obrigatoriedade algumas informações, portanto antes de preencher as informações da contratação em tela, verifique se todas as informações do candidato e da vaga estão preenchidas corretamente. Pode ser necessário inserir informações manualmente caso as mesmas não existam na Gupy.
Se o candidato aprovado foi inserido manualmente na vaga, lembre-se que é necessário que ele aceite o convite enviado por e-mail para que as suas informações pessoais sejam disponibilizadas na Gupy e o fluxo ocorra com sucesso.
Admissão da Pessoa Contratada x Candidato admitido
Para os clientes que possuem o produto Gupy Admissão temos um fluxo de negócio comumente utilizado chamado de Candidato admitido. Caso esse seja o seu caso, clique aqui para obter mais informações.
Updated over 1 year ago