Incode Webhooks
What are webhooks?
Webhooks, also known as "reverse APIs," are a notification mechanism that allows you to send requests from the Incode backend to your API.
This asynchronous mechanism informs your application of the different events that happen in the Incode platform.
What webhooks are available?
- Onboarding status webhook - This webhook triggers every time an Onboarding Session Status changes.
- INE scraping webhook - (Deprecated) Provides the INE Scraping results asynchronously.
- Videoselfie upload webhook - Notifies you when the video selfie recording file becomes available
- Global watchlists webhook - Triggered when a global watchlist result is updated.
- Work history webhook - Triggered after processing the work history search for a user.
- Proof of payment webhook - Triggered after processing the payment proof validation for a user.
Configuring your webhooks
You can configure the webhooks behavior by navigating on the dashboard to Configuration -> Webhooks.
Configuring webhooks destination
You can configure the URL that you wish to use for every webhook. A single URL per webhook is allowed
Each webhook will be sent to only one destination
If you need the webhook on different endpoints in your system, you will have to receive it in a single endpoint and broadcast within your infrastructure
Configuring webhooks custom headers
In the same screen, you can also configure custom headers which you might want to include for your system to receive.
Custom headers are sent on every webhook request made to your system, and they are static (you can't include dynamic values).
Retry Policy
Webhook retries will be triggered in the following scenarios:
- Timeout when calling your endpoint.
- The returned status code from your service is not
200 OKalong with theapplication/jsonheader or the status code204 No content.
The retry policy for webhooks is exponential with an initial interval of 30s, multiplier of 2.5, and max attempts of 5:
| Retry attempt | Delay (seconds) | Delay (minutes) | Total (minutes) |
|---|---|---|---|
| 1 | 30 | 0.50 | 0.5 |
| 2 | 75 | 1.25 | 1.75 |
| 3 | 187.5 | 3.13 | 4.88 |
| 4 | 468.75 | 7.81 | 12.69 |
| 5 | 1,171.88 | 19.53 | 32.22 |
This means the maximum time a webhook can take to reach its destination is approximately 32 minutes.
Whitelisting webhook source IPs
If you need to whitelist IPs to allow inbound traffic into your network, please add the following IP addresses:
- SAAS (production and demo): IP
18.210.119.234 - SAAS EU (production and demo): IP
18.158.116.18
Updated about 1 month ago