matrix-org / matrix-org/matrix-hookshot

Ability to set room topic and avatar via generic webhooks

Open
#653 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

T-Enhancement
Dominant language
TypeScript
Stars
450
Forks
95
Avg merge
1d 2h
Merged PRs (30d)
23

Description

This could for instance be used to reflect the state of something in the room avatar (red failed; green ok) and the topic.

I could imagine at least two ways of doing this:

  1. Extend generic webhooks to send other events than m.room.message.
    It should also support sending multiple messages per call:
    webhook → room message + update room avatar/topic
    Multiple messages could be achieved by turning result into an array.

  2. Add a roomTopic and roomAvatar (mxc) prop to result.
    Generic webhook handler then sends the state events in addition to the message.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the generic webhook handler and the current result shape. Compare the two proposed approaches for sending room messages alongside room topic and avatar state events, including the suggested array form for multiple messages. Done means the issue's chosen design is implemented and the webhook behavior is covered for topic, avatar, and message updates.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.