Push notifications

Retrieve a push rule.

Retrieve a single specified push rule.

get/_matrix/client/v3/pushrules/global/{kind}/{ruleId}

Request

Base URL
https://matrix.org
Auth
- API key in query parameter access_token
- or HTTP bearer
TypeScript
https://skmtc.dev/matrix/apis/matrix-client-server-api/docs/_matrix/client/v3/pushrules/global/:kind/:ruleId/get.ts
A function with typed inputs. Its response is checked against the schema.

kind'override' | 'underride' | 'sender' | 'room' | 'content' required

The kind of rule

ruleIdstring required

The identifier for the rule.

The specific push rule. This will also include keys specific to the rule itself such as the rule's actions and conditions if set.

defaultboolean required

Whether this is a default rule, or has been set explicitly.

enabledboolean required

Whether the push rule is enabled or not.

patternstring

The glob-style pattern to match against. Only applicable to content rules.

rule_idstring required

The ID of this rule.

{
  "conditions": [
    {
      "key": "content.body"
    }
  ]
}

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