matrix-org / matrix-org/matrix-spec
Include sender's avatar in `notify` endpoint
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
[POST /_matrix/push/v1/notify](https://spec.matrix.org/unstable/push-gateway-api/#post_matrixpushv1notify)
**Issue**
Since avatars are some kinda norms when displaying notifications, the current payload spec will probably raise some questions on why that property is not included. I think this should be clarified if there's a good reason behind it. I guessed that one of the reasons might be a permission thing because of the service workers when it comes to web push which probably makes things harder otherwise (not sure).
Also, I noticed that Element app requests the homeserver to fetch more data related to the received event ID inside the push payload.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the POST /_matrix/push/v1/notify section in the linked Matrix Push Gateway API specification and compare it with the Element app behavior described in the issue. Determine whether sender avatar data belongs in the push payload, then update or clarify the specification so the expected payload and rationale are explicit.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100