Skip to main content
Nossos webhooks enviam uma requisição POST para a URL que você configurar sempre que um evento específico ocorre. O corpo da requisição contém um objeto JSON com todos os detalhes do evento.

​
Configuração do Endpoint

Como configurar sua URL de Webhook

A URL para a qual enviaremos os eventos de webhook é configurada pela equipe da Noodle durante o processo de onboarding da sua integração.Para cadastrar uma nova URL ou solicitar alterações, por favor, entre em contato através do e-mail [email protected].

​
O Objeto WebhookEvent

Todos os eventos de webhook são enviados no mesmo formato de envelope. O campo webhook_type indica qual evento ocorreu, e o objeto data contém a carga útil (payload) específica para aquele evento.
AtributoTipoDescrição
webhook_typestringO tipo do evento. Veja a lista completa de tipos abaixo.
event_datedatetimeA data e hora em UTC (YYYY-MM-DDTHH:MM:SSZ) em que o evento foi gerado.
dataobjectUm objeto contendo os dados específicos do evento. A estrutura varia com o webhook_type.

​
Tipos de Eventos e Payloads

A seguir, detalhamos a estrutura do objeto data para cada tipo de evento.
  • qr_code_received
  • split_created
  • split_processed
  • split_payment
Disparado quando um pagamento via QR Code é recebido com sucesso.

​
Atributos

AtributoTipoDescrição
pix_idstringO ID único da transação PIX.
amountfloatO valor total do pagamento recebido.

​
Exemplo de Payload

{
    "webhook_type": "qr_code_received",
    "event_date": "2025-08-13T18:30:00Z",
    "data": {
        "pix_id": "E12345678202508131830sABCdeFG1",
        "amount": 150.75
    }
}

​
Segurança e Verificação

É crucial que você valide a assinatura de cada webhook recebido para garantir que a requisição veio da nossa API e não foi adulterada.
A autenticação dos webhooks segue o mesmo padrão de autenticação JWT (JSON Web Token) descrito na nossa página principal de autenticação. Para cada requisição de webhook, enviaremos um header Authorization com um token Bearer: Authorization: Bearer <seu_jwt_aqui> Para validar a requisição:
  1. Extraia o JWT do header Authorization.
  2. Use a chave pública fornecida pela equipe da Noodle durante o seu processo de onboarding para verificar a assinatura do token.
  3. Se a assinatura for válida, processe o evento. Caso contrário, descarte a requisição.
Para mais detalhes sobre a estrutura do token e as bibliotecas recomendadas para validação, por favor, consulte a nossa documentação de autenticação principal.