> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mx.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Notifications Overview

<Note>
  **NOTE**

  You can only use notifications endpoints if you're using the MX mobile application.
</Note>

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 Fields

| Field | Data Type | Description |
| :- | :- | :- |
| `channel` | Integer | The way the notification will be delivered to the user. See notification channel for more information. |
| `content` | String | The main body of the notification text sent to the user. |
| `created_at` | String | Date the notification was created, as provided by our data feed. Represented in ISO 8601 format (e.g. 2015-04-13T12:01:23-00:00). |
| `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. |
| `delivered_at` | String | Date and time the notification was delivered, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00). |
| `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_delivered` | Boolean | If the notification has been delivered to the user, this field will be true. Otherwise, this field will be false. |
| `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. |
| `subject` | String | The notification summary text. Usually the same text used for "in-app" or SMS notifications. |
| `threshold` | Integer | The amount that needs to be succeeded before the user receives the notification. |

## 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` |