Catálogo de eventos

Os 21 eventos que um webhook pode assinar, com um payload de exemplo em cada schema e a descrição de cada campo. Os nomes são os mesmos que aparecem em Eventos & filtros no portal.

V2todos os eventosV1também disponível (8 eventos de cobrança)Qual escolher?
COBRANÇA

cobranca.paga

Evento de confirmação de pagamento de uma cobrança

Tópico: payment.cobranca.paga.v1Schemas: Trivvo V2 e Trivvo V1
No portal: Trivvo V2 - cobranca.paga (v1.0)
{
  "schemaVersion": "1.0",
  "processedAt": "2025-03-12T09:30:02Z",
  "eventId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "timestamp": "2025-02-28T12:34:56Z",
  "valorPago": 100,
  "moeda": "BRL",
  "formaPagamento": "cartao_de_credito",
  "ofertaId": null,
  "ofertaNome": null,
  "cliente": {
    "nome": "João da Silva",
    "email": "joao.silva@exemplo.com.br",
    "telefone": "+55 11 99999-8888",
    "numeroDocumento": "12345678909"
  },
  "itens": [
    {
      "descricao": "Assinatura Mensal",
      "valor": 50,
      "quantidade": 2,
      "atributosAdicionais": null
    }
  ]
}

Campos · Trivvo V2

Campos de cobranca.paga em Trivvo V2
CampoTipoDescrição
schemaVersionstringRevisão do schema (ex.: 1.0).
processedAtstringQuando a entrega foi gerada (UTC). Muda a cada tentativa.
eventIdstringGerado a cada tentativa. Para deduplicar, use o header X-Request-ID.
idstringIdentificador da cobrança.
timestampstringQuando o fato aconteceu (UTC).
valorPagonumberValor pago, na unidade da moeda.
moedastringCódigo ISO 4217 (ex.: BRL).
formaPagamentostringForma de pagamento (ex.: cartao_de_credito, pix, boleto).
ofertaIdnullOferta de origem; null quando não houver.
ofertaNomenullNome da oferta de origem.
clienteobjectComprador da cobrança.
cliente.nomestringNome do comprador.
cliente.emailstringE-mail do comprador.
cliente.telefonestringTelefone do comprador.
cliente.numeroDocumentostringCPF ou CNPJ do comprador, só dígitos.
itensarrayItens cobrados.
itens[].descricaostringDescrição do item.
itens[].valornumberValor unitário, na unidade da moeda.
itens[].quantidadenumberQuantidade.
itens[].atributosAdicionaisnullAtributos que você cadastrou no produto.

Campos sem valor chegam como null. Novos campos podem ser adicionados ao schema: ignore os que não conhecer. Os objetos de navegador, endereço e rastreamento do Trivvo V1 aparecem completos no exemplo.