Webhooks - Events and Configurations
Webhooks - Anchor
To notify you of events related to your profile (e.g., invoices that have been advanced), webhooks are triggered when such events occur.
When an event happens, the system sends an HTTP POST request to all configured webhooks, containing event details and HATEOAS links for navigating related API 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, configure a webhook by accessing the platform and navigating to Settings -> Webhooks -> Configure.
Events
Event | Registration Type | Search Type | Description |
---|---|---|---|
Payable Transacted | CUSTODY_RESPONSE_GROUPED | CustodyResponseEvent | Sends a request to /payables-response with data of invoices bought or rejected by the investor. |
Payable Deleted | PAYABLE_DELETED | PayableDeletedEvent | Sends a request to /payables with data of the deleted invoice. The request body includes the action eventType: PayableDeletedEvent. |
Payable Duplicated | PAYABLE_DUPLICATED | PayableDuplicatedEvent | Sends a request to /payables with data of the invoice sent for creation but already existing on the platform. The request body includes the action eventType: PayableDuplicatedEvent. |
Bill Generated | BILL_GENERATED | BillGeneratedEvent | Sends a request to /bill with bill data (Bar Code and URL), indicating the bill has not been accepted yet. |
Bill Registered | BILL_REGISTERED | BillRegisteredEvent | Sends a request to /bill with bill data (Bar Code and URL) when it is registered in the DDA. |
Updated 7 months ago