Connect Events

Overview

MoneyKit Connect emits certain events during the flow which enables partner applications to gain further insight into what is going on as their user goes through the linking flow. The events will be surfaced to you through the onEvent callbacks that MoneyKit Connect provides.

The events returned will provide three pieces of data:

Name
Properties
Meta

Event Names

The first piece of information that an event will return is a name. This is how you identify what type of event occurred. Here the the options for event names:

`open`

The user has opened the Link flow.

`exit`

The user has exited without completing the Link flow and the onExit callback is fired.

`success`

The user has exited Link after successfully linking.

`error`

An error occurred in the Link flow. See Errors for more details.

{
	properties: {
		error_id: "",
		displayed_message: ""
		request_id: ""
	}
}

`change_screen`

The user has moved from one view to the next.

{
	properties: {
		current_screen_name: "Finder"
	}
}

`select_institution`

The user selected an institution.

{
	properties: {
		institution_id: "moneykit-creds-bank",
		institution_name: "Credentials Bank"
	}
}

`search_institution`

The user has searched for an institution.

{
	properties: {
		search_term: "moneykit"
	}
}

`acknowledge_institution_alert`

The user has tapped continue on the institution alert.

Note: This can be shown when institutions that have regular downtime or require special information during login

`dismiss_institution_alert`

The user has tapped to dismiss / close the institution alert.

`open_institution_website`

The user has tapped to open the institution website from the institution alert screen.

`submit_credentials`

The user has submitted credentials.

`select_help`

The user has selected the help button on the credentials screen.

`select_reset_password`

The user has selected the reset password button from the help sheet.

`open_oauth`

The user has navigated to a third-party website or mobile app in order to complete the OAuth login flow.

`submit_otp_device`

The user has submitted their preferred device to receive the OTP.

`submit_otp`

The user has submitted the one time password.

`submit_mfa`

The user has submitted MFA.

`submit_permissions`

The user has agreed to the set of permissions prompted for data access.

`submit_accounts`

The user has submitted the accounts which they want to link.

`select_report_issue`

The user has selected the report issue feature.

`submit_report_issue`

The user has submitted an issue to MoneyKit.

Event Properties

The second piece of information that an event will return is the properties. The properties are a collection of key value pairs related to the event and will provide you extra detail related to the event.

For example, when you receive a change_screen event, the properties will inform you which screen was loaded:

{
  "name" : "change_screen",
  "properties" : {
    "current_screen" : "Credentials"
  }
}

Another example is when you search for an institution, the properties will inform you what the end user’s search term was:

{
  "name" : "search_institution",
  "properties" : {
    "search_term" : "BMO Harris"
  }
}

Event Meta

The final piece of information that an event will return is meta, which is another collection of key value pairs with extra detail related to this linking session. For example:

{
	meta: {
		link_type: "Relink",
		link_session_id: "sandbox_b2ac2930-4491-4449-b35d-5677d597d5aa",
		timestamp:"2023-11-28T13:56:20.201Z"
	}
}

The meta will return you the link_type which will inform you if the user is creating a new link or is relinking an existing, broken link. It will also return you the link_session_id in question and the timestamp of the event.

Default properties

All Events

All events should have the following default properties inside the meta node:

Default Properties for All Events

{
	meta: {
		link_type: "Link" | "Relink" | "Failover Link",
		link_session_id: "sandbox_b2ac2930-4491-4449-b35d-5677d597d5aa",
		timestamp:"2023-11-28T13:56:20.201Z"
	}
}

All Link Events

Once an institution has been selected and a link has been started all events should have the following properties available in the meta node:

Default Properties for All Link Events

{
	meta: {
		link_type: "Link" | "Relink" | "Failover Link",
		link_session_id: "sandbox_b2ac2930-4491-4449-b35d-5677d597d5aa",
		institution_id:"moneykit-creds-bank",
		institution_name:"Credentials Bank",
		timestamp:"2023-11-28T13:56:20.201Z"
	}
}

Example Flow

Example Credentials Event Flow

{
  "name" : "open",
  "properties" : {

  },
  "meta" : {
    "link_type" : "Link",
    "link_session_id" : "sandbox_6624ccbc-69bb-4d0d-951a-807715fe6a94",
    "timestamp" : "2023-11-29T12:44:31.804Z"
  }
},
{
  "properties" : {
    "current_screen_name" : "Finder"
  },
  "meta" : {
    "link_type" : "Link",
    "timestamp" : "2023-11-29T12:44:32.176Z",
    "link_session_id" : "sandbox_6624ccbc-69bb-4d0d-951a-807715fe6a94"
  },
  "name" : "change_screen"
},
{
  "properties" : {
    "current_screen_name" : "Loading"
  },
  "name" : "change_screen",
  "meta" : {
    "link_session_id" : "sandbox_6624ccbc-69bb-4d0d-951a-807715fe6a94",
    "link_type" : "Link",
    "institution_name" : "Credentials Bank",
    "timestamp" : "2023-11-29T12:49:39.427Z",
    "institution_id" : "moneykit-creds-bank"
  }
},
{
  "name" : "change_screen",
  "properties" : {
    "current_screen_name" : "Credentials"
  },
  "meta" : {
    "timestamp" : "2023-11-29T12:49:42.208Z",
    "institution_id" : "moneykit-creds-bank",
    "link_type" : "Link",
    "link_session_id" : "sandbox_6624ccbc-69bb-4d0d-951a-807715fe6a94",
    "institution_name" : "Credentials Bank"
  }
},
{
  "meta" : {
    "link_type" : "Link",
    "link_session_id" : "sandbox_6624ccbc-69bb-4d0d-951a-807715fe6a94",
    "timestamp" : "2023-11-29T12:50:17.489Z",
    "institution_name" : "Credentials Bank",
    "institution_id" : "moneykit-creds-bank"
  },
  "name" : "submit_credentails",
  "properties" : {

  }
},
{
  "name" : "change_screen",
  "properties" : {
    "current_screen_name" : "Interactive Loading"
  },
  "meta" : {
    "link_session_id" : "sandbox_6624ccbc-69bb-4d0d-951a-807715fe6a94",
    "institution_id" : "moneykit-creds-bank",
    "institution_name" : "Credentials Bank",
    "timestamp" : "2023-11-29T12:50:18.111Z",
    "link_type" : "Link"
  }
},
{
  "meta" : {
    "link_session_id" : "sandbox_6624ccbc-69bb-4d0d-951a-807715fe6a94",
    "link_type" : "Link",
    "institution_name" : "Credentials Bank",
    "timestamp" : "2023-11-29T12:50:23.049Z",
    "institution_id" : "moneykit-creds-bank"
  },
  "properties" : {
    "current_screen_name" : "Privacy"
  },
  "name" : "change_screen"
},
{
  "name" : "submit_permissions",
  "properties" : {

  },
  "meta" : {
    "institution_name" : "Credentials Bank",
    "institution_id" : "moneykit-creds-bank",
    "link_type" : "Link",
    "timestamp" : "2023-11-29T12:51:07.852Z",
    "link_session_id" : "sandbox_6624ccbc-69bb-4d0d-951a-807715fe6a94"
  }
},
{
  "name" : "change_screen",
  "properties" : {
    "current_screen_name" : "Loading"
  },
  "meta" : {
    "timestamp" : "2023-11-29T12:51:08.368Z",
    "institution_name" : "Credentials Bank",
    "institution_id" : "moneykit-creds-bank",
    "link_type" : "Link",
    "link_session_id" : "sandbox_6624ccbc-69bb-4d0d-951a-807715fe6a94"
  }
},
{
  "name" : "change_screen",
  "properties" : {
    "current_screen_name" : "Accounts"
  },
  "meta" : {
    "institution_id" : "moneykit-creds-bank",
    "link_session_id" : "sandbox_6624ccbc-69bb-4d0d-951a-807715fe6a94",
    "institution_name" : "Credentials Bank",
    "timestamp" : "2023-11-29T12:51:10.823Z",
    "link_type" : "Link"
  }
},
{
  "meta" : {
    "timestamp" : "2023-11-29T12:51:13.987Z",
    "institution_name" : "Credentials Bank",
    "link_type" : "Link",
    "link_session_id" : "sandbox_6624ccbc-69bb-4d0d-951a-807715fe6a94",
    "institution_id" : "moneykit-creds-bank"
  },
  "name" : "submit_accounts",
  "properties" : {

  }
},
{
  "name" : "change_screen",
  "properties" : {
    "current_screen_name" : "Loading"
  },
  "meta" : {
    "institution_id" : "moneykit-creds-bank",
    "timestamp" : "2023-11-29T12:51:14.502Z",
    "link_type" : "Link",
    "link_session_id" : "sandbox_6624ccbc-69bb-4d0d-951a-807715fe6a94",
    "institution_name" : "Credentials Bank"
  }
},
{
  "meta" : {
    "institution_id" : "moneykit-creds-bank",
    "link_session_id" : "sandbox_6624ccbc-69bb-4d0d-951a-807715fe6a94",
    "link_type" : "Link",
    "institution_name" : "Credentials Bank",
    "timestamp" : "2023-11-29T12:52:33.915Z"
  },
  "properties" : {
    "current_screen_name" : "Connected"
  },
  "name" : "change_screen"
},
{
  "name" : "success",
  "meta" : {
    "institution_id" : "moneykit-creds-bank",
    "institution_name" : "Credentials Bank",
    "link_type" : "Link",
    "link_session_id" : "sandbox_6624ccbc-69bb-4d0d-951a-807715fe6a94",
    "timestamp" : "2023-11-29T12:54:33.915Z"
  },
  "properties" : {

  }
}

Overview

Event Names

open

exit

success

error

change_screen

select_institution

search_institution

acknowledge_institution_alert

dismiss_institution_alert

open_institution_website

submit_credentials

select_help

select_reset_password

open_oauth

submit_otp_device

submit_otp

submit_mfa

submit_permissions

submit_accounts

select_report_issue

submit_report_issue