Overview
Webhooks provide real-time notifications when data becomes available for a user. Instead of continuously polling our APIs, you can configure a webhook endpoint to receive instant notifications for a specific use-case.General Webhook Structure
All webhooks are sent as POST requests with JSON payloads containing the following common fields:| Field | Type | Description |
|---|---|---|
event_type | string | Type of webhook event (e.g., ANALYTICS_CALLBACK, CONSENT_REVOKED_CALLBACK) |
transaction_id | string | Unique identifier generated on our side for tracking this transaction |
reference_id | string | Unique identifier provided by your application during user onboarding |
mobile | string | (Optional) User’s mobile number associated with the event |
pan | string | (Optional) User’s PAN number associated with the event |
data_types | array | (Optional) Array of FI types for which the event occurred. Possible values: DEPOSIT, MUTUAL_FUNDS, EQUITIES, TERM_DEPOSIT, RECURRING_DEPOSIT, ETF. Not present in all webhook types. |
Available Webhooks
Analytics Callback Webhook
Analytics Callback Webhook
This webhook triggers when analytics are successfully generated for any new data across financial information types.
Event Details
- Event Type:
ANALYTICS_CALLBACK - Trigger: Analytics successfully generated for new financial data
- HTTP Method:
POST - Content-Type:
application/json
Webhook Payload
When analytics are generated, we send a POST request to your configured webhook URL with the following payload:Nudges Callback Webhook
Nudges Callback Webhook
This webhook triggers when nudges are successfully evaluated and available for a user.
Event Details
- Event Type:
NUDGES_CALLBACK - Trigger: Nudges successfully evaluated and ready for retrieval
- HTTP Method:
POST - Content-Type:
application/json
Webhook Payload
When nudges are evaluated, we send a POST request to your configured webhook URL with the following payload:Consent Revoked Callback Webhook
Consent Revoked Callback Webhook
This webhook triggers when a user revokes one or more consents for financial information access.
Event Details
- Event Type:
CONSENT_REVOKED_CALLBACK - Trigger: User revokes consent(s) for financial data access
- HTTP Method:
POST - Content-Type:
application/json
Webhook Payload
When a consent is revoked, we send a POST request to your configured webhook URL with the following payload:Payload Fields
| Field | Type | Description |
|---|---|---|
no_active_consents | boolean | Indicates the status of remaining consents: - true: All user consents are either revoked, rejected, or expired. No data is available.- false: One or some consents were revoked, but other approved consents still exist. Data availability for remaining consents can be checked by calling the User Data API. |
Response Handling
- When
no_active_consentsistrue: User has no active consents. Guide them to raise new consents via the onboarding flow. - When
no_active_consentsisfalse: Some consents remain active. Call the User Data API to check current data availability and retrieve data for remaining approved consents.
Configuration
To set up webhooks for your application:- Provide Webhook URL: Share your webhook endpoint URL with our technical team
- Endpoint Requirements:
- Must accept POST requests
- Must respond with HTTP 200 status for successful receipt
- Should handle JSON payloads
- Must be accessible via HTTPS
- Encryption Support: We can enable encryption for webhook payloads if required for enhanced security. When enabled, the webhook payload will be encrypted using the same structure as our other encrypted APIs. For more details, see Encrypted Response Format.
Webhook Response Handling
Upon receiving the webhook notification, you can take the following actions:Option 1: Retrieve User Data
Call the User Data API to get the formatted user financial data.Option 2: Retrieve Analytics Data
Call the User Analytics API to get detailed analytics insights.Option 3: Retrieve Nudges Data
Call the User Nudges API to get personalized recommendations and nudges.Best Practices
Security
- HTTPS Only: Only accept webhooks over HTTPS
- Input Validation: Validate all incoming webhook data
- Encryption Support: Webhooks support encryption. When encryption is enabled for your integration, webhook payloads will be encrypted. See API Encryption Guide for details.
Reliability
- Idempotency: Handle duplicate webhook deliveries gracefully
- Response Time: Respond to webhooks within 10 seconds
- Error Handling: Return appropriate HTTP status codes
- Retry Logic: Implement retry logic for failed API calls triggered by webhooks