Client-FD Push API (1.0.0)

This is a unique identifier for this pusher. The value you should use for this is the routing or destination address information for the notification, for example, the APNS token for APNS or the Registration ID for GCM. If your notification client has no such concept, use any unique identifier. Max length, 512 bytes.

If the kind is "email", this is the email address to send notifications to.

The kind of pusher to configure. "http" makes a pusher that sends HTTP pokes. "email" makes a pusher that emails the user with unread notifications. null deletes the pusher.

This is a reverse-DNS style identifier for the application. It is recommended that this end with the platform, such that different platform versions get different app identifiers. Max length, 64 chars.

If the kind is "email", this is "m.email".

Required if kind is not null. A string that will allow the user to identify what application owns this pusher.

Required if kind is not null. A string that will allow the user to identify what device owns this pusher.

This string determines which set of device specific rules this pusher executes.

Required if kind is not null. The preferred language for receiving notifications (e.g. 'en' or 'en-US').

Required if kind is not null. A dictionary of information for the pusher implementation itself.

If kind is http, this MUST contain url which is the URL to use for sending notifications. Clients MAY use this object to pass custom data to their push gateway. Servers MUST forward the entire content including format and any custom keys but excluding url when calling /_matrix/push/v1/notify.

This object contains information on how to encrypt the notifications for the pusher. This property may be required depending on what service it is called on.