Introduction to Webhooks
In this communication model, ilink takes the initiative to notify the ERP whenever a specific event occurs, eliminating the need for frequent API polling.
Oilink provides 2 main webhooks:
- New document webhook - sent to the recipient each time a new document is forwarded
- Document status change webhook - sent to the issuer whenever a previously issued document changes its status
To enable either webhook, the following is required:
- Implement a web endpoint that is publicly accessible to ilink servers, to which ilink will send HTTP requests. The data sent by ilink to this public URL will follow the structure corresponding to the type of webhook you intend to implement.
- Notify the ilink team that you wish to implement the specific webhook for your customer, providing us with an access key and the public URL of your endpoint.
Although this method requires a more extensive implementation, it has the advantage of avoiding constant polling of our servers, consuming fewer resources on both systems, and allowing real-time access to all information. We only recommend opting for manual querying if there are security considerations regarding the use of webhooks (see below).
Retry Policy
A webhook is considered successfully delivered to the ERP when its response returns an HTTP status code 200 (regardless of the response content). We recommend avoiding long processing times on the response endpoint, as the connection may be closed before the processing is completed.
If the communication process fails, ilink will attempt to communicate again up to 10 times within the next 7 days, with progressively longer intervals between each attempt. After 10 failed attempts, ilink will stop trying to deliver that information to the ERP.
| Attempt number | Time until next attempt |
|---|---|
| 1 to 2 | 4 hours |
| 3 to 5 | 5 hours |
| 6 to 9 | 12 hours |