Para que os eventos ocorridos com o seu perfil (ex.: documentos que foram assinados) sejam informados à você, existem Webhooks que são chamados no momento em que tais eventos ocorrem.
Quando um evento acontece, o sistema envia uma requisição HTTP POST para todos os webhooks configurados contendo as informações relativas ao evento e links HATEOAS que auxiliam na navegação da sua API pelos outros recursos que se relacionam com o tipo de evento.
Nossos webhooks contam com um mecanismo de retry, portanto tentamos durante duas horas ou até recebermos o HTTP status 200 OK
Sua API deve respeitar o princípio de idempotência, pois em casos raros o webhook poderá ser entregue mais de uma vez.
Você pode definir um header, um tipo de token e o valor desse token para a autenticação.
Por exemplo:
Authorization: Bearer 6062949f-d17e-4e4d-b359-b3926544e2cc
Você pode restringir as requisições utilizando os IPs da Spike.
Homologação: 34.192.48.76 e 34.192.8.231
Produção: 34.194.174.23 e 23.21.183.94
Para receber estas requisições, você deve configurar um webhook atrvés da API de Configuração de Webhooks.
Evento | Tipo (Cadastro) | Tipo (Busca) | Descrição |
|---|
Assinatura realizada pelo Cedente
|
SELLER_SIGNED
|
SellerSignedEvent
|
Dispara uma requisição para /seller-signature quando o cedente assina a operação.
|
Contrato Registrado
|
CONTRACT
|
ContractRegisteredEvent
|
Dispara uma requisição para /contract quando o contrato de uma operação é registrado na registradora.
|
Contrato Negado
|
CONTRACT_DENIED
|
ContractDeniedEvent
|
Dispara uma requisição para /contract quando o contrato de uma operação é negado na registradora.
|
Contrato Cancelado
|
CONTRACT_CANCELLED
|
ContractCancelledEvent
|
Dispara uma requisição para /contract quando o contrato de uma operação é cancelado na registradora.
|
Cedente Cadastrado
|
SELLER_CREATED
|
SellerCreatedEvent
|
Dispara uma requisição para /seller quando um cedente se cadastra seu cadastro na plataforma.
Enviamos no body da requisição o campo eventType: SellerCreatedEvent.
|
Atualização Cadastral de Cedente
|
SELLER_UPDATED
|
SellerUpdatedEvent
|
Dispara uma requisição para /seller quando um cedente se atualiza seu cadastro na plataforma.
Enviamos no body da requisição o campo eventType: SellerUpdatedEvent.
|
Resumo de Liquidações do Dia
|
LIQUIDATION
|
ContractsItemsLiquidatedEvent
|
Dispara uma requisição para /conciliations informando as operações liquidadas diariamente.
Enviamos no body da requisição o campo eventType: ContractsItemsLiquidatedEvent.
|
Contratos com recomposição expirada
|
RECOMPOSITION
|
RecompositionAttemptsExpiredEvent
|
Dispara uma requisição para /conciliations informando as operações diluídas que atingiram o limite de tentativas de recomposição.
Enviamos no body da requisição o campo eventType: RecompositionAttemptsExpiredEvent.
|
Solicitação de Antecipação Automática Cadastrada
|
AUTOMATED_ORDER_SELLER_CREATED
|
AutomatedOrderSellerCreatedEvent
|
Dispara uma requisição para /automated-order informando as solicitações de antecipação automática que foram solicitadas pelos cedentes.
Enviamos no body da requisição o campo eventType: AutomatedOrderSellerCreatedEvent.
|
