Fluxo de Provisionamento de Equipamentos (Gupy Admissão)

Esse fluxo pode ser construído também no momento da contratação da pessoa candidata no Gupy R&S. Isso pode ocorrer quando o processo admissional é muito rápido e o sistema precisa ser notificado assim que a contratação ocorre. Para entender como esse fluxo pode ser construído a partir do Gupy R&S acesse aqui

📘

Esse fluxo utiliza webhook

Para realizar integrações utilizando Webhooks é necessário um agente integrador (middleware) para receber e tratar os dados.

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

❗️

Notas importantes

Não é possível fechar VPN como rota para entrega do Webhook.

A URL usada para receber o Webhook (postbackUrl) DEVE ser um endereço HTTPS válido, exposto publicamente.

URLs com alta taxa de erro (100% dos erros nos últimos 7 dias) serão removidas sem aviso prévio.

O Webhook espera uma resposta em 30.000 ms. Caso a resposta não tenha ocorrido antes deste tempo, consideramos um timeout, consequentemente, um erro.

A Gupy 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.

NÃO USE serviços como requestcatcher, eles podem expor dados.

Quando setamos algum valor no clientHeaders, o header padrão 'Content-type: application/json;charset=utf-8' não é mais enviado, pois o valor dos headers passa a ser o que foi definido. Se for necessário que o Content-type tenha sempre o valor padrão, recomendamos passá-lo junto no clientHeaders.

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.

Configurando o webhook

Antes de iniciar a integração, é importante alinhar com o desenvolvedor qual será a etapa gatilho. Devido à natureza do webhook, as informações serão disparadas a cada movimentação do candidato entre as etapas, e cabe à integração filtrar qual etapa lhe interessa para seguir com a inclusão dos dados em um sistema terceiro.

Passo 1: Configurar webhook pre-employee.moved

1. Acessar endpoint POST Webhook
2. Alterar parâmetro action para pre-employee.moved
3. Inserir no postbackUrl o endereço para onde será direcionado o webhook
4. Inserir Bearer Token gerado no passo de autenticação e depois clicar em Try it!

Exemplo de requisição

curl --request POST \
     --url https://api.gupy.io/api/v1/webhooks \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
     "action": "pre-employee.moved",
     "status": "active",
     "postbackUrl": "https://urldo.agenteintegrador.net",
     "techOwnerName": "Nome Sobrenome",
     "techOwnerEmail": "[email protected]"
}
'

Exemplo de Resposta

{
  "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  "action": "pre-employee.moved",
  "postbackUrl": "https://urldo.agenteintegrador.net",
  "status": "active",
  "techOwnerName": "Nome Sobrenome",
  "techOwnerEmail": "[email protected]"
}

Fluxo de Integração

1. O fluxo inicia assim que a pessoa pré-colaboradora é movida para a etapa definida para corresponder ao provisionamento de equipamentos, disparando o webhook configurado;
2. Verificação da etapa para qual a pessoa pré-colaboradora foi movida. O fluxo é interrompido caso seja verificado que ela não está na etapa definida;
3. Com a pessoa pré-colaboradora na etapa correta, recuperar os dados necessários como: CPF, nome completo, cargo e posto de trabalho

Obtenção do id da etapa gatilho

Caso sua etapa gatilho seja uma etapa customizada, é possível obter o id da etapa na plataforma indo em:

1. Setup
2. Admissão
3. Definições de etapa
4. Editar etapa de interesse
5. Na URL terá o id da etapa customizada

Passo 3: Recebimento de informações

Neste momento é onde termina a atuação da Gupy na sua integração. Realizaremos a entrega do Webhook dentro do contrato-JSON exemplificado nesse link e o middleware é o responsável pelo tratamento dos dados e definição do fluxo que a integração deve seguir.

Possíveis erros

Recebimento no agente integrador

O ambiente precisa estar público para poder receber os dados, caso contrário, acontecerá um erro.