State Reset Webhook Documentation

Overview

Whenever a client resets the state of an application using case management state reset or via the API, we trigger a webhook to inform them about the state reset action.

Who is this for: SA/IE teams, Support teams When to use: When a client requests state reset webhook integration

Event Type

APPLICATION_STATE_RESET

When It's Sent

1. After successfully executing a state reset action:
   • clear_continuous_state — resets state from a specific module onward
   • clear_complete_state — resets the entire transaction state
2. Only if the event is subscribed for the App ID

Webhook Payload Structure

{
  "eventId": "550e8400-e29b-41d4-a716-446655440000",
  "eventType": "APPLICATION_STATE_RESET",
  "eventTime": "2024-01-15T10:30:00.000Z",
  "appId": "my-app-id",
  "transactionId": "txn-12345",
  "workflowId": "onboarding-workflow",
  "previousStatus": "needs_review",
  "reviewerId": "admin@company.com",
  "resetType": "RESET_FROM_SPECIFIC_STEP",
  "moduleId": "document-verification"
}

Payload Fields

Field	Type	Description	Always Present?
eventId	string	Unique UUID for this event	Yes
eventType	string	Always "APPLICATION_STATE_RESET"	Yes
eventTime	string	ISO timestamp	Yes
appId	string	App ID where reset occurred	Yes
transactionId	string	Transaction ID that was reset	Yes
workflowId	string	Associated workflow ID	Yes
previousStatus	string	Status before the reset	Yes
reviewerId	string	Email of person who performed reset	Yes
resetType	string	Type of reset (see below)	Yes
moduleId	string	Module ID for continuous reset only	No

Reset Types

Action	resetType	Description
clear_continuous_state	"RESET_FROM_SPECIFIC_STEP"	Resets from a specific module onward
clear_complete_state	"COMPLETE_STATE_RESET"	Clears entire transaction state

warning

moduleId is only present when resetType is "RESET_FROM_SPECIFIC_STEP".

Prerequisites for Delivery

Client must be subscribed to the APPLICATION_STATE_RESET webhook event. See client-facing webhook docs.

FAQs

Q: Does the client need to subscribe? A: Yes. The webhook is only sent if the client is subscribed to it.