Os eventos disponíveis estão organizados em torno de duas entidades chave: propostas e vendas. Todos os eventos seguirão o mesmo padrão:

{
  "id-evento": "uuid",
  "evento": "string",
  "criado-em": "date",
  "versao": "1",
  "detalhes": "object"
}

O campo de detalhes é um objeto que varia conforme o evento.

Eventos de proposta

O campo detalhes será da forma abaixo para este conjunto de eventos:

{
  "id-combo-produto": "uuid",
  "id-proposta": "uuid"
}

proposta-criada – Nova proposta criada
proposta-documentos-renderizados – Documentos da proposta estão prontos e podem ser acessados pelo endpoint correspondente
proposta-requisicao-de-cancelamento-criada – Foi criada uma requisição de cancelamento da proposta
proposta-requisicao-de-cancelamento-completa – Uma requisição de cancelamento da proposta foi concluída
proposta-expirada – Proposta não foi concluída durante sua validade e expirou

Eventos de venda

O campo detalhes será da forma abaixo para este conjunto de eventos:

{
  "id-combo-produto": "uuid",
  "id-proposta": "uuid",
  "id-venda": "uuid"
}

venda-criada – Nova venda criada a partir de uma proposta recém concluída
venda-completa – Processo de emissão concluído
venda-documentos-renderizados – Documentos de venda estão prontos e podem ser acessados pelo endpoint correspondente
venda-requisicao-de-cancelamento-criada – Foi criada uma requisição de cancelamento da venda
venda-requisicao-de-cancelamento-completa – Uma requisição de cancelamento da venda foi concluída

Eventos de renovação

O campo detalhes será da forma abaixo para este conjunto de eventos:

{
  "id-combo-produto": "uuid",
  "id-renovacao": "uuid",
  "id-venda": "uuid"
}

renovacao-disponivel: Uma renovação está disponível (pela primeira vez ou para nova tentativa).
renovacao-iniciada: Uma renovação foi iniciada com sucesso. Uma proposta foi criada que pode ou não ter pendências (como pagamento).
renovacao-completa: O processo de renovação foi concluído com sucesso. A emissão de renovação já aconteceu.
renovacao-cancelada: A renovação foi cancelada e não pode mais ser utilizada.

Eventos de pagamento

Os seguintes eventos de pagamento estão disponíveis e podem ser utilizados para realização de conciliação bancária através do campo id-transacao-financeira. O valor desse campo depende do método de pagamento que foi utilizado (ex. "E20018183202408141147aseRqGSJGHM" no caso de Pix, "STR20240812033553406" no caso de pagamento via TED, e número de boleto no caso de pagamento via boleto).

sinistro-pagamento-concluido: O pagamento de um sinistro foi realizado.

{
  "id-combo-produto": "uuid",
  "id-proposta": "uuid",
  "id-venda": "uuid",
  "id-sinistro": "uuid",
  "id-transacao-financeira": "string",
  "valor": "numero",
  "data-pagamento" "string YYYY-MM-DD"
}

cancelamento-pagamento-concluido: O pagamento do reembolso de cancelamento foi realizado.

{
  "id-combo-produto": "uuid",
  "id-proposta": "uuid",
  "id-venda": "uuid",
  "id-cancelamento": "uuid",
  "id-transacao-financeira": "string",
  "valor": "numero",
  "data-pagamento" "string YYYY-MM-DD"
}

Evento "ping" para validação da URL de destino

Na criação ou atualização de assinaturas de eventos, a URL de destino pode ser verificada com a tentativa de entrega de um evento síncrono. O campo detalhes deste evento será:

ping: evento de verificação para URL de destino

{
  "mensagem": "Evento recebido!"
}