Notifications Overview

Notifications provide automated alerts to users based on specific financial events or conditions.

Notifications Fields

Notifications are resources used to provide a message to the user and are often tied to other resources (known as entities) such as an Account or Budget. Notifications alone are not delivered to the user. Deliverables should be created that represent the specific text that will be sent to the user as an email, SMS, push or an in-app message.

Field name	Data type	Description
created_on	string	Date the notification was created, as provided by our data feed. Represented in ISO 8601 format (e.g. 2011-03-28).
deep_link_guid	string	The unique identifier for objects that directly trigger a notification. EX: TRANSACTION_FEE_CHARGE and TRANSACTION_EXPENSE_LARGE notification types will have a transaction guid in this field.
entity_guid	string	The unique identifier of the entity that the notification is attached to.
guid	string	Unique identifier for the notification. Defined by MX.
has_been_viewed	boolean	If the notification has been viewed, this field will be true. Otherwise, this field will be false.
notification_type	integer	Specific type of notification being sent. See notification types for more information.
notification_type_name	string	The name of the notification type. See notification types for more information.
subject	string	The notification summary text. Usually the same text used for “in-app” or SMS deliverables.
threshold	integer	The amount that needs to be succeeded before the user receives the notification.

Notification Types

Notification type	Definition
1	BUDGET_EXCEEDED
2	BUDGET_OFF_TARGET
3	DEBT_PAYMENT_REMINDER
4	GUIDE_ME_STEP_COMPLETE
5	GUIDE_ME_OFF_TARGET
6	ACCOUNT_BALANCE_LOW
7	ACCOUNT_DEPOSIT_LARGE
8	TRANSACTION_EXPENSE_LARGE
9	TRANSACTION_FEE_CHARGE
10	SYSTEM_NOTIFICATION
11	API_NOTIFICATION
12	USER_SUMMARY
13	OFFER
14	PASSWORD_RESET_TOKEN
15	PASSWORD_CHANGED
16	EMAIL_VERIFICATION
17	EMAIL_VERIFIED
18	WELCOME_NEW_USER
19	DEVICE_CREATED
20	DEVICE_DELETED
21	SMS_VERIFICATION
22	ACCOUNT_NEARING_ZERO
23	TRANSACTION_IS_INTERNATIONAL
24	INVALID_CONTACT_INFORMATION
25	GOAL_PROGRESS
26	CREATE_GOAL
27	FORGOT_USERNAME_REMINDER
28	SMS_WELCOME_MESSAGE
29	DUPLICATE_PAYMENT

Deliverable Notification Fields

Field Name	Data Type	Description
channel	integer	The way the notification will be delivered to the user. See deliverable notification channel for more information.
channel_name	string	The channel name through which the notification will be delivered. See deliverable notification channel for more information.
content	string	The full content to be delivered in the given channel. For email, should be the fully rendered HTML body (...).
delivered_at	string	Date and time the deliverable was delivered, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
delivered_on	string	Date and time the deliverable was delivered, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
guid	string	Unique identifier for the notification. Defined by MX.
has_been_delivered	boolean	If the deliverable has been delivered to the user, this field will be true. Otherwise, this field will be false.

Deliverable Notification Channels

Channel	Definition
1	EMAIL
2	PUSH
3	SMS
4	IN_APP