Notifications Overview - MX Documentation

You can only use notifications endpoints if you’re using the MX mobile application.

For field names, types, and descriptions, see the response schema on each endpoint page, such as Read Notifications and List Notifications.

All notifications created through the API will be of notification type API_NOTIFICATION, channel PUSH, and will not be associated to an entity. No other channels are supported. The read and list endpoints can return any notification associated with the user, including notifications created by MX for other channels besides PUSH.

Notification Channels

Channel	Definition
1	EMAIL
2	PUSH
3	SMS
4	IN_APP

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`