Overview:#
Webhook Notifications is a feature of WAuth that enables developers to receive real-time notifications on successful user verifications.When a user successfully completes the verification process, WAuth sends a HTTP POST request to the webhook URL configured in the developer's API account. This documentation explains the format of the webhook payload and how developers can use the data to update the verification status.Webhook Payload:#
The webhook payload is a JSON data object in the following format: "sessionId": "79a656167f3a87cb-SIN",
"verificationStatus": "Y",
"verifiedName": "John Doe",
"verifiedPhone": "919998887776",
"callbackParam1": "token1234",
"callbackParam2": "",
"callbackParam3": ""
}
The payload contains the following fields:#
sessionId: A unique session ID generated by WAuth
verificationStatus: The verification status, either 'Y' for successful verification or 'N' for failed verification
verifiedName: The name of the verified user
verifiedPhone: The verified user's phone number
callbackParam1-3: Optional callback parameters that can be passed during the verification process.
Using Webhook Notifications:#
Developers can use the webhook payload to update the verification status in their local database and redirect the user to the appropriate screen in their app or website. The sessionId field can be used as a reference to update the verification status for the correct user. The verificationStatus field can be used to determine whether the verification was successful or not.To use Webhook Notifications, developers need to configure the webhook URL in their API account. The webhook URL should be a publicly accessible URL that can receive HTTP POST requests.Conclusion:#
Webhook Notifications is a powerful feature of WAuth that enables developers to receive real-time notifications on successful user verifications. By using the webhook payload, developers can update the verification status in their local database and redirect the user to the appropriate screen in their app or website. To use Webhook Notifications, developers need to configure the webhook URL in their API account.Modified at 2023-02-16 18:13:08
