Um webhook é um método de comunicação entre sistemas que possibilita o trâfego de mensagens automaticamente quando um evento acontece.
Em vez de depender de verificações periódicas para atualização dos dados, como acontece com abordagens de polling, um webhook permite que um sistema seja notificado instantaneamente quando uma ação relevante ocorre.

Usamos webhooks para facilitar a integração entre sistemas de forma eficiente. Os dados serão enviados em formato JSON.

Registro

Para utilizar nosso webhook, é preciso realizar o registro conosco. Para isso, envie um email para [email protected] contendo a url de integração (para onde os eventos serão enviados) e o métodos HTTP usado para enviar eventos (POST, GET etc).

Dados

Temos os seguintes dados trafegados no webhook:

Parâmetro	Tipo	Descrição
apiVersion	string	Versão da API do contrato do webhook
applicationId	string	Identificador da aplicação ou serviço que está utilizando o webhook
messageId	string	Identificador único da mensagem do webhook
environment	string	Ambiente em que o evento ocorreu (por exemplo: produção, desenvolvimento, teste etc)
events	lista	Lista de eventos capturados pelo webhook
createdDate	string	Data e hora em que o contrato do webhook foi criado

Dentro da lista de eventos, encontramos os seguintes dados:

Parâmetro	Tipo	Descrição
eventId	string	Identificador único do evento
eventType	string	Tipo de evento ocorrido
data	object	Dados relacionados ao evento
occurredDate	string	Data e hora em que o evento ocorreu

Exemplo de json contendo os dados:

{
  "apiVersion": "1.0",
  "applicationId": "f91ab099-1696-4746-af10-c95b9d4e4d72",
  "messageId": "a7c024b7-50c5-4cee-aa8f-82f9b1d0dea7",
  "environment": "sandbox",
  "createdDate": "2022-04-25T12:00:00",
  "events": [
    {
      "eventId": "c1126046-77fe-44d4-bd6d-df09d304c293",
      "eventType": "evento_tipo_1",
      "data": {
        "key1": "valor1",
        "key2": "valor2",
        "key3": "valor3"
      },
      "occurredDate": "2022-04-25T12:05:00"
    },
    {
      "eventId": "event2",
      "eventType": "evento_tipo_2",
      "data": {
        "key1": "valor1",
        "key2": "valor2",
        "key3": "valor3"
      },
      "occurredDate": "2022-04-25T12:10:00"
    }
  ]
}

Eventos

Os eventos enviados estão listados abaixo. Os dados serão incluídos no campo data, dentro de cada evento.

Atualização de status do cedente

Esta notificação será disparada quando o(s) cedente(s) sofrer alteração no status. Os status possíveis do cedente são:

Status	Descrição
ACTIVE	O cedente está habilitado para a cessão
DISABLED	O cedente está desabilitado para a cessão

Atualização de status do lote

Esta notificação será disparada quando os créditos contidos no lote forem analisados e houver uma modificação no status dos ativos e do lote.
O lote pode ter os seguintes status:

Status	Descrição
PENDING	O processamento do lote não começou
PROCESSING	O lote está sendo processado
SUCCESS	O lote foi processado com sucesso
ERROR	Ocorreu um erro durante o processamento do lote

Atualização de status da cessão de crédito

Esta notificação será enviada sempre que houver uma mudança de status na cessão de crédito. A cessão pode ter os seguintes status:

O Ativo pode ter os seguintes status:

Status	Descrição
CREATED	A cessão foi criada
ANALYZING	A cessão está sendo analisada
AWAITING_FORMALIZATION	Aguardando criação do termo de cessão
FORMALIZATION_SENT	Termo de cessão enviado para assinatura de contra-partes
AWAITING_REGISTRATION	A cessão está aguardando registro dos créditos na registradora
REGISTRATION_PROCESSED	Registradora retornou com o resultado de solicitação de registro dos créditos
AWAITING_SETTLEMENT	A cessão está aguardando liquidação
SETTLED	A cessão foi liquidada
COMPLETED	O processo de cessão foi concluído
REFUSED	A cessão foi recusada e não será processada
CANCELED	A cessão foi cancelada e não será processada
ERROR	Ocorreu um erro no processamento da cessão

Atualização de status do ativo durante o processo de cessão

Status	Descrição
CREATED	O crédito foi criado
ELIGIBLE	O crédito é elegível para a cessão
INELIGIBLE	O crédito é inelegível para cessão
SELECTED	O crédito foi selecionado para compra
NOT_SELECTED	O crédito não foi selecionado para compra
ACQUIRED	O crédito foi adquirido ao término do processo de cessão
CANCELED	A cessão foi cancelada

Máquina de estado da cessão