Application State Reset
Objective
The Application State Reset feature enables the resetting of user application states when issues occur or when users need to retry their journey from a specific step. This functionality enhances user experience by allowing controlled retries and troubleshooting of application workflows directly within integrated applications.
The Application State Reset provides granular control over user application states, enabling efficient troubleshooting and user support through API integration.
This feature enables:
- Targeted state resets from specific modules or complete workflows
- Enhanced user support capabilities through integrated applications
- Improved conversion rates through controlled retries
- Comprehensive audit trails for compliance
- Seamless integration with existing systems
Application State Reset requires authentication and authorization. Only authorized personnel with valid credentials can perform state reset operations.
Implementation Overview
To implement the Application State Reset feature in your application, integrate the following APIs and webhook:
| API Name | Description | Implementation Notes |
|---|---|---|
| State Reset Options API | Retrieves available reset points for a given application based on the current user journey state. Provides a list of steps in the user journey (moduleId's) that can be used as reset points. | • Fetches available reset points • Based on current journey state • Returns moduleIds for reset options |
| State Reset API | Triggers the actual state reset operation—mirroring HV One dashboard functionality. Performs the state reset operation based on the selected module or complete reset option. | • IP whitelisting is mandatory • Accepts reviewerId parameter • Supports two reset types (defined within the action parameter) • Mirrors dashboard functionality |
| State Reset Webhook | Provides immediate notifications when state reset operations are performed, enabling real-time monitoring and logging. | • Once the reset is successful, a webhook would be sent from HV containing the necessary details. • Contains reset details • Enables monitoring & logging |