Fluxo de Provisionamento de Equipamentos (R&S)

Esse fluxo pode ser construído também durante o processo admissional da pessoa pré-colaboradora no Gupy Admissão. 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

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 Webhook espera uma resposta em 30.000 ms. Caso a resposta não tenha ocorrido antes deste tempo, consideramos um timeout, consequentemente, um erro.

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.

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

Esse webhook sempre será disparado com os dados de pré-contratação da pessoa candidata forem salvos.

Passo 1: Configurar webhook candidate.hired

1. Acessar endpoint POST Webhook
2. Alterar parâmetro action para candidate.hired
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": "candidate.hired",
     "status": "active",
     "postbackUrl": "https://urldo.agenteintegrador.net",
'

Exemplo de Resposta

{
  "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  "action": "candidate.hired",
  "postbackUrl": "https://urldo.agenteintegrador.net",
  "status": "active",
}

Fluxo de Integração

1. O fluxo inicia assim que a pessoa candidata é movida para a etapa de contratação e os dados de pré-contratação são salvos.
2. Recebimento dos dados pelo agente integrador via webhook
3. Recuperar os dados necessários como: CPF, nome completo, cargo e posto de trabalho (normalmente o posto de trabalho é configurado como um campo customizado e deve ser localizado no objeto customFields [] do payload enviado pelo webhook).

Passo : Recebimento de informações E início do processo de provisionamento de equipamentos.

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.