Connection Status
Connection status webhooks notify you whenever a member's connection_status field enters into an end-user-actionable state.
The following connection statuses will trigger this webhook:
CHALLENGEDDENIEDEXPIREDIMPAIREDIMPEDEDLOCKEDPREVENTEDREJECTED
| Field | Data Type | Definition |
|---|---|---|
action | String | This value should always equal CHANGED. |
connection_status | String | The state of a member’s aggregation, provided as a string. |
connection_status_id | Integer | The state of a member’s aggregation, provided as an integer. |
connection_status_message | String | A message that can be displayed to the end user to help them navigate the connection and aggregation process. |
member_guid | String | The unique identifier for the member that triggered the webhook. Defined by MX. |
type | String | The type of webhook being delivered. |
user_guid | String | The unique identifier for the user with which the member is associated. Defined by MX. |
Example Payload:
_10{_10 "action": "CHANGED",_10 "connection_status": "CHALLENGED",_10 "connection_status_id": 3,_10 "connection_status_message": "To authenticate your connection to Chase Bank, please answer the following challenge(s).",_10 "member_guid": "MBR-48d9a481-f2a2-7e13-2685-62869cf0d33a",_10 "type": "CONNECTION_STATUS",_10 "user_guid": "USR-eaf4ac68-d17d-5e9b-7b46-959a5b315a9e"_10}