Webhooks
Webhooks are event notifications that update the application. These are typically push notifications that allow the API caller/app to listen to the notification and update their business process as necessary.
Steps to receive Webhook notification
1. Provide the Necessary Information
To onboard your webhook and start receiving notifications, follow these steps:
1.1 Sign in to the Developer Portal.
2.2 Navigate to the API Keys page: https://developer.snapfinance.com/api-keys
3.3 Locate your API key and click the Register button under the Register Webhook column.
4.4 In the popup window, enter the required details (such as your webhook URL and Merchant ID).
5.5 Click Register Webhook to submit and complete the setup.
Note: Ensure your webhook endpoint is publicly accessible, supports HTTPS, and can handle HTTP POST requests with JSON payloads.
Alternatively you can send an email to devsupport@snapfinance.com with the following details:
- Listener URL Endpoint: The URL where you want to receive webhook notifications.
- Merchant ID (MID): Your unique Merchant ID for the integration.
2. What to Expect from Snap Webhooks
Snap webhooks provide synchronous, event-driven notifications that inform partners and merchants of status changes in applications.
{5 items
"applicationId":string"2603AA009NUT"
"currentApplicationStatus":string"PENDING"
"currentApplicationSubStatus":string"BLANK"
"finalApplicationStatus":string"APPROVED"
"finalApplicationSubStatus":string"BLANK"
}
| Event Name | Final Application Status | |
|---|---|---|
Pending | Withdrawn | |
Approved | ||
Denied |
| Event Name | Final Application Status | |
|---|---|---|
Prequalified | Approved | |
Withdrawn | ||
Denied |
| Event Name | Final Application status | |
|---|---|---|
Pending signed docs | Pending delivery | |
Complete | ||
Withdrawn |
| Event Name | Final Application status | |
|---|---|---|
Pending delivery | Complete | |
Withdrawn |
Features
Webhook Events
This webhook triggers when there is a change in an application's status, including transitions like "Approved," "Complete," and others. These updates are essential for tracking and managing application workflows.
Webhook Subscription
Webhook subscriptions let you register an endpoint to receive real-time notifications for specific events, such as APPLICATION_STATUS_CHANGE. You can manage your subscriptions via API, specifying which events to receive and the target delivery URL.
Webhook Unsubscription
Unsubscribing stops your endpoint from receiving notifications for specific events or all events. You can unsubscribe at any time through the user interface or API to control which webhooks you receive.