Docs
EntrarCriar conta
Ambiente
Base URLhttps://api.sancopay.com/api/v1
Arquivo para IA
Webhooks

Cadastrar

Cadastre as URLs HTTPS da sua aplicação que recebem os eventos: cobrança paga, saque concluído, pré-aprovação e recorrência. Toda entrega chega assinada com HMAC-SHA256 no header X-Webhook-Signature. Também dá para cadastrar pela tela Webhooks do painel.

  • GET/webhooksLista os webhooks cadastrados (o signing_secret nunca é listado).
  • POST/webhooksCadastra uma URL. A resposta traz o signing_secret, exibido uma única vez.
  • POST/webhooks/{id}/rotate-secretGera um novo signing_secret; o anterior deixa de valer na hora.
  • DEL/webhooks/{id}Remove um webhook.
  • POST/webhooks/testCorpo { "url" }: testa se a URL responde antes de cadastrá-la, com um webhook.test, e devolve { reachable, ok, status, message }. É a única chamada que sai sem assinatura.
POST/webhooks

Cadastra uma URL de notificação.

Corpo da requisição

CampoTipoDescrição
urlobrigatóriostringURL HTTPS pública que recebe os eventos.
Requisição
curl -X POST "https://api.sancopay.com/api/v1/webhooks" \  -H "Authorization: Bearer <TOKEN>" \  -H "Content-Type: application/json" \  -d '{    "url": "https://sualoja.com.br/webhooks/sancopay"  }'
Resposta201 Created

Guarde o signing_secret agora: ele não aparece de novo.

{  "id": 7,  "url": "https://sualoja.com.br/webhooks/sancopay",  "is_active": true,  "created_at": "2026-11-09T15:04:05.000000Z",  "updated_at": "2026-11-09T15:04:05.000000Z",  "signing_secret": "whsec_9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"}

O recurso webhook

id
Id do webhook.
url
A URL cadastrada.
is_active
Se as entregas estão ligadas.
signing_secret
O segredo da assinatura (whsec_…). Só vem na criação e no rotate-secret.

Gerar um novo segredo

Requisição
curl -X POST "https://api.sancopay.com/api/v1/webhooks/7/rotate-secret" \  -H "Authorization: Bearer <TOKEN>"
Resposta200 OK

O novo signing_secret, exibido uma única vez.

{  "id": 7,  "url": "https://sualoja.com.br/webhooks/sancopay",  "is_active": true,  "created_at": "2026-11-09T15:04:05.000000Z",  "updated_at": "2026-11-09T15:04:05.000000Z",  "signing_secret": "whsec_9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"}