Como utilizar a API da Gupy: Webhooks

O que você encontra aqui: 

• Eventos do Webhook
• Exemplo de integrações via API

--------------------------------------------------------------------------------------------------------------------

Este artigo faz parte de uma série explicativa sobre como utilizar a API pública da Gupy e realizar integrações com outros sistemas. Aqui falaremos sobre como utilizar o Webhook e exemplos de integrações. 

Se você quiser acompanhar os outros artigos da série, acesse:

• Como utilizar a API da Gupy: Primeiros passos;
• Como utilizar a API da Gupy: Operações disponíveis; 
• Como utilizar a API da Gupy: Webhooks(você está aqui); 

Webhooks

Os Webhooks são notificações que são enviadas sempre que algum evento específico ocorre na Gupy. Em resumo, é possível configurar uma URL específica para receber um arquivo JSON sempre que um evento, dentre os webhooks disponibilizados, ocorre.

Os eventos que são disponibilizados, são: 

 

• Inscrição criada: evento disparado sempre que uma pessoa candidata se aplica para uma vaga ou quando é feita uma inserção manual de um candidato pela empresa

Documentação:https://developers.gupy.io/reference/application-created-event_

 

• Inscrição completa: evento disparado sempre que uma inscrição é finalizada para uma vaga.

Documentação:https://developers.gupy.io/reference/application-completed-event

 

• Inscrição movimentada: evento disparado sempre que uma inscrição é movimentada de uma etapa para outra.

Documentação:https://developers.gupy.io/reference/application-moved-event

 

• Pessoa candidata contratada: evento disparado sempre que as informações de contratação são inseridas no modal de contratação dentro da plataforma

Documentação:https://developers.gupy.io/reference/candidate-hired-event

 

• Vaga publicada: evento enviado sempre que uma nova vaga é publicada na plataforma da empresa.

Documentação:https://developers.gupy.io/reference/job-published

 

• Status de vaga atualizado: evento emitido sempre que o status de uma vaga é alterado, por exemplo, de publicada para congelada.

Documentação:https://developers.gupy.io/reference/job-status-changed

 

• Vaga atualizada: o evento é emitido sempre que temos alguma alteração em uma vaga

Documentação:https://developers.gupy.io/reference/job-changed

 

• Configurações de webhook

A configuração de um webhook pode ser feita através da API Pública da Gupy a partir das seguintes operações:

 

Operações	Resultados
[POST] Configuring webhooks	Viabiliza a configuração de um novo webhook
[GET] Listing webhook configurations	Lista as configurações ativas existentes com os webhooks da Gupy
[DELETE] Deleting webhook configurations	Exclui a configuração de um webhook específico
[PUT] Updating webhook configurations	Atualiza as informações de um webhook

 

Documentação: https://developers.gupy.io/reference/webhook-configurations

 

Importante: Para que o envio de webhooks seja um sucesso, é importante que os servidores estejam habilitados para receberem requisições HTTPS dos seguintes endereços IP:

• 3.225.75.195
• 3.213.125.198
• 3.81.178.137
• 18.235.49.246
• 18.209.132.16
• 34.231.178.88
• 34.237.26.228
• 52.3.10.144
• 54.87.127.240

 

Exemplos de Integrações

Na Gupy, buscamos possibilitar que nossos clientes consigam ter um processo extremamente fluido entre nosso sistema e os demais utilizados no dia a dia das empresas. Para isso, nossa API e Webhooks buscam dar diversas opções às empresas, mas, no geral, exemplos de integrações comumente realizadas são as seguintes:

1. Criação de vaga após aprovação de requisição em sistema externo: É comum os clientes da Gupy utilizarem o endpoint de criação de vagas ([POST] Creating a job) para criar vagas na plataforma de forma automática sempre que for feita uma aprovação externa. Por exemplo, algumas empresas possuem em seus ERPs a possibilidade de solicitar a substituição de um funcionário sempre que é feito um desligamento. Com a integração, é possível que a Gupy seja o “final” desse fluxo, criando a vaga assim que todas as aprovações devidas forem realizadas.
   
   
2. Sincronização de cargos, áreas e estrutura organizacional: Com o objetivo de assegurar a conformidade dos dados cadastrais de usuários na Gupy com demais sistemas da empresa, muitas vezes os endpoints de cargo ([PUT] Updating a role); áreas ([PUT] Updating a department) e estrutura organizacional ([PUT] Updating branch) podem ser utilizados para garantir a atualização e conformidade de informações.