Lenme Webhook Events
This page will provide detailed descriptions and updates for all Lenme webhooks.
Overview
The Lenme system tracks any changes to resources (like Loan Requests, Loan Payments, etc..) by creating an Event object whenever an action occurs. These events are formatted consistently and include:
Webhook UUID: Identifies your webhook uuid value.
Event topic: Identifies the type of change.
Event data: Data Collection for an occurred Event.
If you've subscribed to webhooks, you'll receive notifications whenever relevant events occur within your integration.
Webhook Topics
Topics identify the events that have occurred. Each topic is included in the header and payload to specify the event and its details. This section of the documentation will be updated frequently with new webhook event topics as they are added to our system. Currently, we have one topic: new_loan_request_created
. As new topics are introduced, they will be documented here.
Table of Topics
Topic Name | Description |
---|---|
new_loan_request_created | When a new loan request is created, the provided data will include five variables:
|
Subscribe to Lenme Webhooks
To request a subscription, provide a valid URL and a registered email. We will supply you with a webhook secret key, used to encode the webhook payload for data verification and reception. The webhook payload will contain a JWT-encoded token with the necessary data.
Webhook request details
Webhook Delivery:
When you configure a webhook subscription, Lenme will create events for resource changes and send them asynchronously to your designated URL. These notifications arrive as POST requests containing a JSON-encoded payload (the event data) and additional HTTP headers.
Focus on Event Details:
Webhook payloads are designed to be lightweight, containing only essential details about the triggered event.
Webhook headers
Lenme Webhook Headers:
Several HTTP headers accompany Lenme webhook notifications to aid your application in processing the request:
X-Lenme-Topic: This header identifies the general event category included in the payload (e.g., "new_loan_request_created").
Content-Type: specifies the media type of the resource or the data being sent.
Example of header:
X-Lenme-Topic: new_loan_request_created
Content-Type: application/json
Webhook payload
All webhook payloads will include an Event object which will follow the same format as explained into #lenme-events, these events will contain the following:
Value | Type | Description |
---|---|---|
webhook_uuid | string | Universally unique identifier for an event. |
topic | string | Identify the event that occurred. |
data | JSON | The event's JSON data. |
Example webhook payload
Webhook Delivery and Retry Mechanism
By default, we will send you the webhook immediately after the event occurs. We will wait for up to 60 seconds for your server to respond. If your server does not respond within this time frame, we will mark the event as not sent and retry sending the webhook.
If your server cannot receive the webhook initially, our system will retry sending it every hour for up to 24 hours. If no 200 response is received within this period, your subscription will be deactivated until you request reactivation.
Next Steps
For detailed information on how to integrate and handle Lenme webhooks in your application, please proceed to the next section.
Last updated