Eventos

Catálogo completo dos eventos que a Pitra entrega nos seus endpoints.

Envelope

{
  "id": "evt-uuid",
  "object": "event",
  "type": "sale.approved",
  "api_version": "2024-01-01",
  "created": 1735689600,
  "data": {
    "object": {
      "object": "sale",
      "id": "9c8b7a6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d",
      "codigo": "PTR-4821",
      "product_id": "6f1b1c9e-6a0a-4a2f-9d0c-2b1c4a5e7f10",
      "status": "approved",
      "valor": 197.9,
      "metodo_pagamento": "pix",
      "email": "cliente@exemplo.com",
      "whatsapp": "5511999999999",
      "origin": "checkout",
      "bump_product_id": null,
      "bump_valor": null,
      "created_at": "2026-07-30T12:00:00.000Z"
    }
  }
}
CampoDescrição
idIdentificador único do evento. Use-o para deduplicar.
typeNome do evento.
api_versionVersão do contrato do payload (2024-01-01).
createdTimestamp Unix em segundos.
data.objectO recurso afetado, com os mesmos campos públicos da API REST.

Headers da entrega

Pitra-Signature: t=1735689600,v1=<hmac_sha256_hex>
Pitra-Event-Id: evt-uuid
Pitra-Event-Type: sale.approved
Pitra-Delivery-Id: dlv-uuid
Pitra-Attempt: 1
EventoQuando ocorredata.object
product.createdUm produto foi criado.product
product.updatedUm produto foi atualizado.product
product.archivedUm produto foi arquivado (tornou-se inativo).product
checkout.createdUm checkout foi criado.checkout
checkout.updatedUm checkout foi atualizado.checkout
checkout.archivedUm checkout foi arquivado.checkout
sale.createdPedido criado, aguardando pagamento.sale
sale.approvedPagamento confirmado.sale
sale.refusedPagamento recusado.sale
sale.canceledPedido cancelado.sale
sale.refundedPedido reembolsado.sale
delivery.sentAcesso enviado ao comprador.sale
Os payloads usam exatamente os mesmos campos públicos dos objetos da API REST. Nada além desses campos é enviado.

API v1 · OpenAPI 1.0.0 · SDK 0.1.0