LLiccenDocs

Endpoints cadastrados

URLs fixas que recebem os eventos escolhidos de todas as cobranças e transferências da aplicação.

Para a maioria das integrações, enviar webhook_url na criação da cobrança é mais simples e não exige cadastro. Veja Receber eventos. O endpoint cadastrado serve para quem quer um destino único para tudo, ou receber eventos de cobranças criadas fora da API, como as do checkout.

São os mesmos endpoints que aparecem na dashboard, dentro da aplicação que emitiu a chave: o que você cadastra aqui é visível lá, e o contrário também. Cada aplicação vê apenas os próprios endpoints, então uma conta que opera duas lojas mantém as duas separadas usando uma aplicação para cada.

Listar

GET/v1/webhooksescopo: webhook:read
Resposta 200
{
  "object": "list",
  "data": [
    {
      "id": "5e2f...",
      "object": "webhook",
      "url": "https://meusistema.com.br/hooks/pagamentos",
      "description": "Baixa de pedidos",
      "events": ["charge.pix.emitted", "charge.pix.paid"],
      "active": true,
      "has_secret": true,
      "created_at": "2026-07-28T14:00:00.000Z"
    }
  ]
}

O segredo nunca volta em resposta alguma: has_secret apenas informa que existe um configurado.

Criar

POST/v1/webhooksescopo: webhook:write

Corpo

url
stringobrigatório
Endereço que recebe os POSTs.
events
array de stringobrigatório
Ao menos um evento, no formato recurso.método.ação. Ver a página de eventos.
description
stringopcional
Para você reconhecer o endpoint na lista.
secret
stringopcional
Mínimo 8 caracteres. Passa a assinar as entregas.
cURL
curl -X POST https://api.transakto.io/v1/webhooks \
  -H "x-api-key: sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://meusistema.com.br/hooks/pagamentos",
    "events": ["charge.pix.paid", "charge.pix.refunded"],
    "description": "Baixa de pedidos",
    "secret": "um-segredo-bem-longo"
  }'

Atualizar

PATCH/v1/webhooks/{id}escopo: webhook:write

Aceita url, events, description, secret e active. Enviar apenas { "active": false } pausa as entregas sem apagar o cadastro, o que é o caminho certo durante uma manutenção do seu servidor.

Remover

DELETE/v1/webhooks/{id}escopo: webhook:write

Responde 204, sem corpo. Id inexistente, de outra conta ou de outra aplicação devolve 404 com WEBHOOK_NOT_FOUND.

Catálogo de eventos

GET/v1/webhooks/eventsescopo: nenhum

Devolve todos os eventos que a plataforma conhece, com as três partes do nome separadas, a descrição e o campo dispatched, que é falso enquanto a plataforma ainda não chega a emitir aquele evento. Não exige escopo: a lista é a mesma da documentação.

Resposta 200
{
  "object": "list",
  "data": [
    {
      "event": "charge.pix.paid",
      "resource": "charge",
      "method": "pix",
      "action": "paid",
      "description": "Pix liquidado. É o evento que dá baixa no pedido.",
      "dispatched": true
    }
  ]
}
AnteriorReceber eventosPróximaEventos