Webhooks
Receba notificações em tempo real sobre eventos do GTPayroll. Os webhooks permitem que seu sistema seja informado automaticamente quando operações importantes são concluídas — sem necessidade de polling.
Como funciona
Quando um evento relevante ocorre no GTPayroll (ex: consulta de margem concluída, averbação finalizada, pagamento realizado), o sistema envia uma requisição HTTP POST para as URLs configuradas na sua assinatura de webhook.
O fluxo:
Um evento ocorre no GTPayroll (ex: margem consultada)
O sistema identifica a assinatura de webhook do originador
Uma requisição POST é enviada para cada URL configurada
Em caso de falha, o sistema faz retry automático com backoff exponencial
Os webhooks são enviados server-to-server. Seu endpoint precisa estar acessível publicamente via HTTPS.
Pré-requisitos
URL(s) de webhook
Um ou mais endpoints HTTPS que receberão as notificações
Header de autenticação
Nome e valor do header para autenticação (ex: Authorization: <token>)
Assinatura ativa
A assinatura de webhook precisa estar ativa para o originador
Configuração
A configuração de webhook é feita por originador. Cada originador pode ter:
Múltiplas URLs — o mesmo evento é enviado para todas as URLs configuradas
Header customizado — você define o nome e valor do header de autenticação
Ativação/desativação — a assinatura pode ser ativada ou desativada a qualquer momento
Configuração via API
O originator pode criar, consultar, atualizar e remover sua subscription de webhook pela API. Veja Configuração via API para os endpoints e exemplos.
Formato da requisição
Todas as notificações são enviadas como HTTP POST com Content-Type: application/json.
O header de autenticação (Authorization no exemplo acima) é configurável — o nome e valor são definidos na assinatura do webhook.
Atualizado