Skip to content

POST_MESSAGES.md

Latest commit

 

History

History
46 lines (36 loc) · 8.97 KB

POST_MESSAGES.md

File metadata and controls

46 lines (36 loc) · 8.97 KB

← Post Messages

The connect widget uses post messages to communicate with the parent window.

onPostMessage

The onPostMessage function is used to send messages to the parent window.

const onPostMessage = (event: string, data?: object) => {
  console.log('onPostMessage', event, data)
}

Post Messages

Post Message Events
Type Description Data
mx/connect/backToSearch Triggers when an end user selects a button that will navigate them to the search institution step in the Connect Widget. Used in relation with disable_institution_search config option. 
{}
mx/connect/loaded Triggers when the Connect Widget has loaded. initial_step can be connected, disclosure, enterCreds, loginError, mfa, search, verifyExistingMember or verifyMfa. 
{
  "initial_step": string
}
mx/connect/initialDataReady Triggers when the initial data for a job on a member is complete and ready for use. 
{
  "member_guid": string
}
mx/connect/enterCredentials Triggers when a user submits credentials for a given institution for the first time. 
{
  "institution": {
     "code": string,
     "guid": string
  }
}
mx/connect/institutionSearch Triggers when the end user searches for an institution. 
{
  "query": string
}
mx/connect/selectedInstitution Triggers when the end user selects an institution from the institution list. 
{
  "code": string,
  "guid": string,
  "name": string,
  "url": string
}
mx/connect/invalidData Triggers when there are no valid demand deposit (DDA) accounts on the member. Current options for code: 1000 
{
  "code": string,
  "member_guid": string
}
mx/connect/invalidData/primaryAction Triggered when the user clicks the "Try again" option on the invalid data step. 
{
  "member_guid": string
}
mx/connect/memberConnected Triggers when a member has successfully connected and the data you requested in your config has finished aggregating. 
{
  "member_guid": string
}
mx/connect/memberConnected/primaryAction Triggered when the user clicks the primary button on the member connected step. 
{}
mx/connect/memberError Triggers when a member has encountered an error state. 
{
  "member": {
     "guid": string,
     "connection_status": number
  }
}
mx/connect/createMemberError Triggers when a member failed to get created when credentials were entered. 
{
  "institution_guid": string,
  "institution_code": string
}
mx/connect/memberDeleted Triggers when a member has been deleted in the widget. 
{
  "member_guid": string
}
mx/connect/memberStatusUpdated Triggers when a members connection status has changed while connecting. This is useful in determing the current connection status of the member. 
{
  "member_guid": string,
  "connection_status": number
}
mx/connect/oauthError Triggered when the user lands on the OAuth error page. 
{
  "member_guid": string
}
mx/connect/oauthRequested Triggers when the user navigates to the OAuth provider's site. Note that the redirect does not happen in WebViews. 
{
  "url": string,
  "member_guid": string
}
mx/connect/stepChange Triggers when the end user changes from one "step" to another. 
{
  "previous": string,
  "current": string
}
mx/connect/submitMfa Triggers when a user submits an MFA answer. 
{
  "member_guid": string
}
mx/connect/updateCredentials Triggers when a user submits credentials while trying to update their existing credentials. 
{
  "member_guid": string,
  "institution": {
     "code": string,
     "guid": string
  }
}

<-- Back to README