Webhooks - Events and Configurations

Webhooks - Investor

To notify you of events related to your profile (e.g., signed documents), webhooks are triggered when such events occur.

When an event happens, the system sends an HTTP POST request to all configured webhooks, containing event information and HATEOAS links to navigate your API to related resources.

Our webhooks have a retry mechanism, attempting for two hours or until an HTTP 200 OK status is received.

Your API should adhere to the idempotency principle, as webhooks might be delivered more than once in rare cases.

Webhook Configuration

To receive these requests, you need to configure a webhook. To do this, access the platform and navigate to Settings -> Webhooks -> Configure.

Events

EventRegistration TypeSearch TypeDescription

Signature Completed/Rejected by Supplier

SELLER_SIGNED

SELLER_NOT_SIGNED

SellerSignedEvent

SellerNotSignedEvent

Sends a request to /seller-signature when the seller signs or rejects the operation.

Signature Completed/Rejected by Anchor

SPONSOR_SIGNED

SPONSOR_NOT_SIGNED

SponsorSignedEvent

SponsorNotSignedEvent

Sends a request to /sponsor-signature when the debtor signs or rejects the operation.

Purchase Completed

PURCHASE

PurchaseCreatedEvent

Sends a request to /purchase when a transaction is completed.

Supplier Registered

Updated

BUYER_SELLER

BuyerSellerCreatedEvent

BuyerSellerUpdatedEvent

Sends a request to /seller when a supplier registers or updates their profile on the platform.

When registering: eventType: SellerCreatedEvent.

When updating: eventType: SellerUpdatedEvent.

Supplier Documentation Registered

Updated

BUYER_SELLER_DOCUMENT

BuyerSellerDocumentCreatedEvent

BuyerSellerDocumentUpdatedEvent

Sends a request to /seller-documents with supplier documentation when registered or updated.

When registering: eventType: SellerDocumentCreatedEvent.

When updating: eventType: SellerDocumentUpdatedEvent.

Adhesion Term Signed by Seller

ADHESION_TERM_SIGNED

AdhesionTermSignedEvent

Sends a request to /adhesion-term when the seller signs the adhesion term.

Anchor Registered

Updated

BUYER_SPONSOR

BuyerSponsorCreatedEvent

BuyerSponsorUpdatedEvent

Sends a request to /sponsor when a anchor registers or updates their profile on the platform.

When registering: eventType: SponsorCreatedEvent.

When updating: eventType: SponsorUpdatedEvent.

Bill Generated

BILL_GENERATED

BillGeneratedEvent

Sends a request to /bill when a bill is generated.

Bill Registered

BILL_REGISTERED

BillRegisteredEvent

Sends a request to /bill when a bill is registered in DDA.

Bill Settlement

CUSTODY_RESPONSE

PurchaseItemLiquidatedEvent

Sends a request to /liquidations when a purchase is settled by the anchor.

Rate File Processed

TAX_FILE_PROCESSED

TaxFileProcessedSuccessEvent

TaxFileProcessedErrorEvent

Sends a request to /tax-file when rate file processing is completed.