Configurando eventos para ser notificado via webhook

Sobre este guia

Através deste guia, demonstraremos como configurar eventos para você ser notificado via webhook.

Passo a passo

Ambientes

• Ambiente de homologação: https://uat-collaborators-api.acessorh.com.br;
• Ambiente de produção: https://collaborators-api.acessorh.com.br.

1. Obtenha um token OAuth válido

   Caso tenha dúvidas de como obter um token visite a seção sobre autenticação.

2. Configurando um webhook

   Após gerar um token de acesso válido, faça uma requisição para o endpoint de configuração de eventos na nossa API REST (POST/webhook/configurations). Eventos possíveis:

   • EMPLOYEE_CREATION - Quando houver uma criação de uma pessoa colaboradora.
   • EMPLOYEE_UPDATE - Quando houver uma atualização de uma pessoa colaboradora.
   • IMPORT_FINISH - Quando houver a conclusão de uma importação de arquivos.

   Abaixo um exemplo de requisição:

   curl --location 'https://collaborators-api.acessorh.com.br/webhook/configurations' \
   --header 'accountid: {ACCOUNT}' \
   --header 'Content-Type: application/json' \
   --header 'authorization: Bearer {ACCESS_TOKEN}' \
   --data '{
       "headers": {
           "post": "man"
       },
       "endpoint": "https://webhook.site/b57864a0-2a9e-436e-8a87-e2453c418a19",
       "events": ["EMPLOYEE_CREATION", "EMPLOYEE_UPDATE", "IMPORT_FINISH"]
   }'