Event-Based Notifications – Webhooks
Webhooks make it possible to send information to any URL. Event-based webhooks let you send information every time one of the LoanPro events occurs. This is most used to notify applications programmed by customers when events occur in LoanPro. Here is some useful information to help you decide whether webhooks will meet your needs:
Events That Include a Webhook
- Insurance Updated
- Autopay Failed
- Autopay Scheduled/Created
- Loan Settings Updated
- Loan Promise Created
- Loan Collateral Updated
- Document attached to Account
- Advancement Posted to Account
- Credit Posted to Account
- Past Due Adjustment Posted to Account
- Change Due Date Posted to Account
- Funding Transaction Posted to Account
- Payment Posted to account
- Payment Reversed
- Loan Charge Posted
- Loan Charge Reversed
- Archive Account
- Delete Account
- Account Created
- Account Modified
- Account Activated
- Customer Logs into Customer Website
- Customer Created
- Customer Updated
- Payment Profile Added
- Employer Updated
- References Added
- Agent User Created
Information That Can Be Sent in a Webhook Payload:
Format of a Webhook Payload
Here's the JSON payload from a webhook:
"eventName": "Account Activated",
"source-company": "Smoke Test Co",
Setting Up a Webhook
To set up a webhook, navigate to Settings > Company > Notifications > Event Based Notifications.
Make sure you are on the Webhook tab and that the webhook is enabled. Enter the URL you want to call into the “Callback URL” field.
If you want to restrict which loans can trigger this webhook, use the options in the “Restrictions” section to narrow which loans can trigger it.
Finally, enter the variables that will be sent to your chosen URL when the event occurs. Click HELP VARIABLES to search the available variables. Note that you will only need to enter the variable names (e.g. status-amount-due) and the listed variables should be separated by commas. When you are done, click 'Save'.
This Webhook Site is a great resource for testing webhook functionality.
You also have the ability to see webhooks that have been triggered on an account in the Servicing > Notes/Alerts > SYSTEM NOTES section of the account.
If a webhook fails, LoanPro will retry three times. The first will be 30 seconds after the original failed, the second will be 2 minutes after that, and the third will be 10 minutes later.
Additionally, each webhook response will include a trace ID. This is in the payload for logging purposes, allowing LoanPro to see which of the retries succeeded, and will have no effect on your processes.