Skip to main content
Webhooks permitem que o CGD notifique o seu sistema automaticamente quando eventos importantes ocorrem, como mudancas de status de pedidos ou atribuicao de motorista. Voce registra uma URL e o CGD envia requisicoes HTTP POST para ela com os dados do evento.

Endpoints


Eventos disponiveis


Registrar webhook

Campos da requisicao

Resposta


Estrutura do payload

Quando um evento ocorre, o CGD envia uma requisicao POST para a URL cadastrada com o seguinte payload:

Campos do payload


Verificacao de assinatura

Cada requisicao de webhook inclui o header X-Signature com a assinatura HMAC-SHA256 do payload. Voce deve verificar essa assinatura para garantir que a requisicao veio do CGD e nao foi adulterada.

Como calcular a assinatura esperada

Compare o resultado (em hexadecimal) com o valor do header X-Signature.

Verificacao em Node.js

Verificacao em PHP

Sempre use hash_equals (PHP) ou crypto.timingSafeEqual (Node.js) para comparar assinaturas. Comparacoes diretas com === sao vulneraveis a timing attacks.

Retentativas

O CGD reenvia o evento automaticamente em caso de falha (timeout ou status HTTP diferente de 2xx): Apos 5 tentativas sem sucesso, o evento e marcado como falho e nao e mais reenviado.

Gerenciamento de webhooks

Listar webhooks

Atualizar webhook

Remover webhook