Webhooks - Investidor

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.

Configuração de Webhook

Para receber estas requisições, você deve configurar um webhook, para isso acesse a plataforma e vá em Configurações -> Webhooks -> Configurar

Eventos

Evento	Tipo (Cadastro)	Tipo (Busca)	Descrição
Assinatura realizada/recusada pelo Cedente	SELLER_SIGNED SELLER_NOT_SIGNED	SellerSignedEvent SellerNotSignedEvent	Dispara uma requisição para /seller-signature quando o cedente assina ou recusa a operação.
Assinatura realizada/recusada pelo Sacado	SPONSOR_SIGNED SPONSOR_NOT_SIGNED	SponsorSignedEvent SponsorNotSignedEvent	Dispara uma requisição para /sponsor-signature quando o sacado assina ou recusa a operação.
Compra Realizada	PURCHASE	PurchaseCreatedEvent	Dispara uma requisição para /purchase quando uma operação é realizada.
Cedente Cadastrado Atualização Cadastral de Cedente	BUYER_SELLER	BuyerSellerCreatedEvent BuyerSellerUpdatedEvent	Dispara uma requisição para /seller quando um cedente se cadastra ou atualiza seu cadastro na plataforma. Quando o cedente se cadastra, enviamos no body da requisição o campo eventType: SellerCreatedEvent. Quando o cedente atualiza seu cadastro, enviamos no body da requisição o campo eventType: SellerUpdatedEvent.
Documentação de Cedente Cadastrado Atualização de Documentação Cadastral	BUYER_SELLER_DOCUMENT	BuyerSellerDocumentCreatedEvent BuyerSellerDocumentUpdatedEvent	Dispara uma requisição para /seller-documents com a documentação do cedente quando o mesmo se cadastra ou atualiza seu cadastro na plataforma. Quando o cedente se cadastra, enviamos no body da requisição o campo eventType: SellerDocumentCreatedEvent. Quando o cedente atualiza seu cadastro, enviamos no body da requisição o campo eventType: SellerDocumentUpdatedEvent.
Termo de Adesão Assinado pelo Cedente	ADHESION_TERM_SIGNED	AdhesionTermSignedEvent	Dispara uma requisição para /adhesion-term quando o cedente realiza a assinatura do termo de adesão.
Sacado Cadastrado Atualização Cadastral de Sacado	BUYER_SPONSOR	BuyerSponsorCreatedEvent BuyerSponsorUpdatedEvent	Dispara uma requisição para /sponsor quando um sacado se cadastra ou atualiza seu cadastro na plataforma. Quando o sacado se cadastra, enviamos no body da requisição o campo eventType: SponsorCreatedEvent. Quando o sacado atualiza seu cadastro, enviamos no body da requisição o campo eventType: SponsorUpdatedEvent.
Boleto Gerado	BILL_GENERATED	BillGeneratedEvent	Dispara uma requisição para /bill quando um boleto é gerado.
Boleto Registrado	BILL_REGISTERED	BillRegisteredEvent	Dispara uma requisição para /bill quando um boleto é registrado no DDA.
Liquidação de títulos	CUSTODY_RESPONSE	PurchaseItemLiquidatedEvent	Dispara uma requisição para /liquidations quando uma compra é liquidada pelo sacado.
Arquivo de taxas processado	TAX_FILE_PROCESSED	TaxFileProcessedSuccessEvent TaxFileProcessedErrorEvent	Dispara uma requisição para /tax-file quando o processamento de um arquivo de taxas é finalizado.