Push notifications

Retrieve all push rules.

Retrieve all push rules for this user.

get/_matrix/client/v3/pushrules/global/

Request

Response

All the push rules for this user.

Example response

{
  "override": [
    {
      "actions": [],
      "conditions": [],
      "default": true,
      "enabled": false,
      "rule_id": ".m.rule.master"
    },
    {
      "actions": [],
      "conditions": [
        {
          "key": "content.msgtype",
          "kind": "event_match",
          "pattern": "m.notice"
        }
      ],
      "default": true,
      "enabled": true,
      "rule_id": ".m.rule.suppress_notices"
    }
  ],
  "room": [],
  "sender": [],
  "underride": [
    {
      "actions": [
        "notify",
        {
          "set_tweak": "sound",
          "value": "ring"
        },
        {
          "set_tweak": "highlight",
          "value": false
        }
      ],
      "conditions": [
        {
          "key": "type",
          "kind": "event_match",
          "pattern": "m.call.invite"
        }
      ],
      "default": true,
      "enabled": true,
      "rule_id": ".m.rule.call"
    },
    {
      "actions": [
        "notify",
        {
          "set_tweak": "sound",
          "value": "default"
        },
        {
          "set_tweak": "highlight"
        }
      ],
      "conditions": [
        {
          "key": "content.m\\.mentions.user_ids",
          "kind": "event_property_contains",
          "value": "@alice:example.com"
        }
      ],
      "default": true,
      "enabled": true,
      "rule_id": ".m.rule.is_user_mention"
    },
    {
      "actions": [
        "notify",
        {
          "set_tweak": "sound",
          "value": "default"
        },
        {
          "set_tweak": "highlight",
          "value": false
        }
      ],
      "conditions": [
        {
          "is": "2",
          "kind": "room_member_count"
        },
        {
          "key": "type",
          "kind": "event_match",
          "pattern": "m.room.message"
        }
      ],
      "default": true,
      "enabled": true,
      "rule_id": ".m.rule.room_one_to_one"
    },
    {
      "actions": [
        "notify",
        {
          "set_tweak": "sound",
          "value": "default"
        },
        {
          "set_tweak": "highlight",
          "value": false
        }
      ],
      "conditions": [
        {
          "key": "type",
          "kind": "event_match",
          "pattern": "m.room.member"
        },
        {
          "key": "content.membership",
          "kind": "event_match",
          "pattern": "invite"
        },
        {
          "key": "state_key",
          "kind": "event_match",
          "pattern": "@alice:example.com"
        }
      ],
      "default": true,
      "enabled": true,
      "rule_id": ".m.rule.invite_for_me"
    },
    {
      "actions": [
        "notify",
        {
          "set_tweak": "highlight",
          "value": false
        }
      ],
      "conditions": [
        {
          "key": "type",
          "kind": "event_match",
          "pattern": "m.room.member"
        }
      ],
      "default": true,
      "enabled": true,
      "rule_id": ".m.rule.member_event"
    },
    {
      "actions": [
        "notify",
        {
          "set_tweak": "highlight",
          "value": false
        }
      ],
      "conditions": [
        {
          "key": "type",
          "kind": "event_match",
          "pattern": "m.room.message"
        }
      ],
      "default": true,
      "enabled": true,
      "rule_id": ".m.rule.message"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.