API de webhooks

Gerencie as assinaturas de webhook do seu programa. A conferência de assinatura, as novas tentativas e o catálogo completo de eventos estão no guia de webhooks.

API v1 · Legado

Esta página faz parte da referência da primeira versão da API da Web3Card, mantida aqui para consulta. A API v1 não recebe integrações novas: a API v2 a substitui, e a plataforma hoje funciona como descrito no resto deste manual.

POST /webhooks

Cria uma assinatura.

// Request
{
  "url": "https://api.yourproject.com/hooks/web3card",
  "events": ["transaction.*", "kyc.*", "vault.credited"]
}

// Response
{
  "id": "wh_2210",
  "url": "https://api.yourproject.com/hooks/web3card",
  "events": ["transaction.*", "kyc.*", "vault.credited"],
  "status": "active",
  "secret": "whsec_9k3j…"
}

O secret só vem na criação. Guarde com segurança; ele assina cada entrega.

GET /webhooks

Lista as suas assinaturas.

GET /webhooks/{id}

Consulta uma assinatura e os números recentes de entrega.

PATCH /webhooks/{id}

Altera o endereço ou os eventos escolhidos.

DELETE /webhooks/{id}

Apaga uma assinatura. As novas tentativas pendentes são canceladas.

POST /webhooks/{id}/rotate-secret

Troca o segredo de assinatura. O segredo antigo continua valendo por uma hora, para a troca acontecer sem parada.

POST /webhooks/{id}/test

Envia um evento ping assinado para o seu endereço, para conferir a conexão de ponta a ponta.

// Response
{ "delivered": true, "responseStatus": 200, "latencyMs": 184 }

Formato da entrega

{
  "id": "evt_88d1",
  "type": "transaction.created",
  "createdAt": "2026-07-19T14:00:00Z",
  "data": { … }
}

Cabeçalhos de toda entrega:

Cabeçalho	Conteúdo
X-W3C-Signature	HMAC SHA-256 do corpo bruto
X-W3C-Event-Id	Id do evento, para não processar duas vezes
X-W3C-Event-Type	Tipo do evento