Na seção Gestão de Webhooks e APIs você pode criar e administrar webhooks que enviam eventos do Pandapé para seus sistemas, consultar o consumo mensal da API e acessar as credenciais técnicas. É o lugar para integrar o Pandapé às suas aplicações (ERP, HRIS, BI, etc.) e manter um controle claro.
Antes de começar, recomendamos consultar o artigo Glossário de termos-chave (Webhooks & API), onde explicamos conceitos técnicos como endpoint, URL HTTPS, token, Client ID/Secret, etc., que revisaremos ao longo deste guia.
Este artigo aborda os seguintes temas:
Como acessar
- Na sua conta do Pandapé ATS, acesse Configurações.
- Na seção Outras configurações, selecione Webhooks e APIs.
O que você pode consultar e gerenciar
- Consumo do último mês: mostra o número total de solicitações de Webhook e de API requests realizadas. Esses contadores são atualizados a cada hora, portanto não refletem os dados em tempo real.
- Credenciais de acesso à API: inclui a documentação técnica, seu Client ID e Client Secret, necessários para integrações seguras.
- Webhooks configurados: lista de todos os webhooks ativos criados na sua conta.
- Últimas 10 solicitações de Webhook: oferece uma visão rápida do status mais recente dos seus envios. Para mais informações, consulte: Dados de logs de Webhook.
- Novo webhook: permite criar um novo webhook diretamente a partir desta seção. Consulte a parte Como criar um novo webhook para ver os passos detalhados.
Como criar um novo webhook
Ao criar um webhook, você define qual evento o Pandapé notificará, para qual endereço a informação será enviada e como esse envio é autenticado. Siga estes passos:
- Clique em Novo webhook.
- Na janela Criar webhook, insira um Nome (ex.: Cadastro de candidato – ATS – ERP).
- Selecione o Evento que deseja ativar (ex.: Candidato inscrito em uma vaga). Para ver todos, consulte: Tipos de eventos disponíveis nos webhooks.
- Informe a URL de destino: o endpoint HTTPS do seu sistema que receberá a notificação.
- Escolha o método de autenticação do envio. Selecione uma das três abas —Sem autorização, Token estático ou Token dinâmico— e preencha os dados correspondentes (explicamos cada uma abaixo).
- Em Configurar para, defina o alcance do webhook:
- Todas as vagas: o webhook será ativado diante do evento em qualquer processo.
- Uma vaga específica: ficará limitado a um processo específico.
- Recomendamos clicar em Testar Webhook para verificar a conexão com o seu endpoint. Você verá um resultado de sucesso ou de erro.
- Clique em Salvar para finalizar a configuração.
A seguir, explicamos os três métodos de autenticação que você pode escolher:
|
Método de autenticação |
Quando usar e o que preencher? |
| Sem autorização | O envio não inclui token. Use se o seu endpoint não precisa validar a origem da solicitação. |
| Token estático | Você define manualmente um token estático no campo Token (até 4.000 caracteres). O Pandapé o inclui em cada envio deste webhook. |
| Token dinâmico | O Pandapé obtém o token automaticamente do seu sistema antes de cada envio. Você deve informar: URL do token, Client ID e Client Secret. Seu provedor deve ser compatível com OAuth 2.0 (RFC 6749). |
Como funciona o Token dinâmico? (OAuth 2.0)
O Token dinâmico utiliza o padrão OAuth 2.0 (RFC 6749) no seu fluxo Client Credentials, projetado para a comunicação entre sistemas (de máquina a máquina), sem intervenção de um usuário. Antes de cada envio, o Pandapé obtém automaticamente um token de acesso do seu provedor de autenticação e o inclui no webhook, para que o seu sistema possa validar a origem da solicitação.
O processo ocorre em três momentos:
1. O Pandapé solicita o token
O Pandapé envia uma requisição para a sua URL do token com estas características:
- Método:
POST. - Cabeçalho:
Content-Type: application/x-www-form-urlencoded. - No corpo da requisição, inclui estes parâmetros:
|
Parâmetro |
Presença |
Descrição |
grant_type
|
Obrigatório |
Valor fixo: client_credentials.
|
client_id
|
Obrigatório | Seu Client ID. |
client_secret
|
Obrigatório | Seu Client Secret. |
scope
|
Opcional |
Escopo do token, se o seu provedor exigir (ex.:
webhooks:receive).
|
2. O seu provedor responde com o token
Se as credenciais forem válidas, o seu provedor responde com 200 OK e um objeto JSON com o token:
|
Campo |
Descrição |
access_token
|
Token de acesso que o Pandapé usará na chamada do webhook. |
token_type
|
Tipo de token. Conforme a RFC 6749, deve ser Bearer.
|
expires_in
|
Validade do token, expressa em segundos. |
scope
|
Escopo concedido ao token (se aplicável). |
3. O Pandapé envia o webhook
O Pandapé inclui o access_token (do tipo Bearer) na chamada à sua URL de destino. O seu sistema valida esse token e processa a informação somente se ele for válido.
- Padrão aceito: a autenticação com Token dinâmico aceita exclusivamente o padrão OAuth 2.0 (RFC 6749). Certifique-se de que o seu provedor de autenticação seja compatível com esse padrão.
- Cliente confidencial: este fluxo é destinado a clientes confidenciais, capazes de proteger o seu Client Secret em um ambiente de backend seguro.
-
Sem tokens de atualização: este fluxo não utiliza tokens
de atualização (
refresh tokens). Quando o Pandapé precisa de um token novo, ele o solicita novamente com as suas credenciais. - Compatibilidade: os webhooks com Token estático que você já tem configurados continuam funcionando sem alterações.
Dica:
- Use Testar Webhook antes de salvar para confirmar que a conexão com o seu endpoint funciona. Se o resultado for de erro, revise a URL de destino e, na autenticação, os dados do token.
Tipos de eventos disponíveis nos webhooks
A seguir, você encontrará os tipos de eventos que pode selecionar ao criar um webhook no Pandapé.
Cada evento define quando a notificação automática é disparada para o seu sistema (endpoint), de acordo com a ação ou mudança registrada dentro do ATS.
|
Tipo de evento |
Descrição |
| Candidato inscrito em uma vaga | Enviado quando um candidato conclui a inscrição em uma vaga. |
| Candidato mudou de estágio em uma vaga | Enviado ao mover o candidato entre estágios do processo seletivo. |
| Avaliação do candidato salva | Enviado ao salvar uma avaliação no perfil do candidato. |
| Questionário foi completado | Enviado quando um questionário associado ao processo é finalizado. |
| A Vídeo Entrevista foi atualizada | Enviado ao criar ou atualizar uma Vídeo Entrevista. |
| Avaliação Geral do candidato foi atualizada | Enviado ao alterar a avaliação geral do perfil do candidato. |
| Requisição mudou de status | Enviado quando uma requisição tem seu status alterado. |
| Candidato enviado para uma requisição | Enviado ao encaminhar um candidato no módulo de Requisições. |
| Candidato mudou de estágio em uma requisição | Enviado ao mover o candidato entre estágios em uma requisição. |
| Sede criada | Enviado quando uma sede é criada. |
| Candidato enviado para admissão | Enviado ao enviar o candidato para o módulo de Admissão. |
| Pré-Colaborador mudou de etapa no processo de admissão | Enviado quando o pré-colaborador muda de etapa no processo de Admissão. |