======================
privateMessage
======================

| Receive a notification when a private message is sent or received.
| Includes :ref:`objects:message`, :ref:`objects:broadcaster`, and :ref:`objects:user` objects.

.. note::
    There is a separate notification for :ref:`public chat messages<methods/chatMessage:chatMessage>`.

Example Output
--------------

.. code-block:: json

    {
      "message": {
        "color": "",
        "toUser": "testuser",
        "bgColor": null,
        "fromUser": "testuser1",
        "message": "hello",
        "font": "default",
      },
      "broadcaster": "testuser",
      "user": {
        "username": "testuser1",
        "inFanclub": false,
        "gender": "m",
        "hasTokens": true,
        "recentTips": "none",
        "isMod": false
      }
    }