# Epic SMHEI-9 - Matrix hookshot customization for OpenProject

Project: Stream Matrix Hookshot - Element Integration
Status: in progress
URL: https://community.openproject.org/work_packages/SMHEI-9

## Detailed specification

### Motivation and background information

### Acceptance criteria

### Out of scope

| Attribute | Value |
| --- | --- |
| Mockups |  |

## Planning

| Attribute | Value |
| --- | --- |
| Roadmap |  |
| Date |  |
| Votes |  |
| List |  |
| Target versions | 0.1.16 |
| Relevance |  |

## Subitems

| ID | Type | Subject | Status | Assignee | Target versions | Project | Priority | Spent time |
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
| SMHEI-22 | Feature | Commenting on work packages fires a webhook | tested |  | 16.2.0 | Stream Matrix Hookshot - Element Integration | High |  |
| SMHEI-28 | Feature | Improve instructions in chat room for setting up the Hookshot widget | new | Will Hunt | Product Backlog | Stream Matrix Hookshot - Element Integration | Medium |  |
| SMHEI-29 | Feature | Not clear question "Allow this widget to verify your identity" | new | Will Hunt | Product Backlog | Stream Matrix Hookshot - Element Integration | Medium |  |
| SMHEI-30 | Feature | Improve OpenProject instance selection; less distraction to log-in | new | Will Hunt | Product Backlog | Stream Matrix Hookshot - Element Integration | Medium |  |
| SMHEI-31 | Feature | Improve instructions after successful OAuth granting | new | Will Hunt | Product Backlog | Stream Matrix Hookshot - Element Integration | Medium |  |
| SMHEI-32 | Feature | Improve screen for linking projects | new | Will Hunt | Product Backlog | Stream Matrix Hookshot - Element Integration | Medium |  |
| SMHEI-33 | Feature | Improve list of connected projects | new | Will Hunt | Product Backlog | Stream Matrix Hookshot - Element Integration | Medium |  |
| SMHEI-34 | Feature | Improve project configuration | new | Will Hunt | Product Backlog | Stream Matrix Hookshot - Element Integration | Medium |  |
| SMHEI-6 | Feature | Matrix hookshot customization | closed | Will Hunt |  | Stream Matrix Hookshot - Element Integration | Medium |  |
| SMHEI-16 | Feature | Allow saving matrix handles per user | in specification | Dominic Bräunlein |  | Stream Matrix Hookshot - Element Integration | Medium |  |
| SMHEI-17 | Feature | Allow saving Matrix room ID with a project | in specification | Dominic Bräunlein |  | Stream Matrix Hookshot - Element Integration | Medium |  |
| SMHEI-18 | Feature | Setup script for openDesk and other application bundles | new |  |  | Stream Matrix Hookshot - Element Integration | Medium |  |
| SMHEI-24 | Feature | Allow ` !openproect help` without mentioning project identifier | in specification | Danielle Kirkwood |  | Stream Matrix Hookshot - Element Integration | Medium |  |

## Bugs and other work packages

| ID | Type | Subject | Status | Assignee | Target versions | Module |
| --- | --- | --- | --- | --- | --- | --- |
| SMHEI-20 | Documentation | Add Matrix hookshot admin guide | in progress |  |  |  |
| SMHEI-27 | Bug | Events appear for projects that are not configured in the room | confirmed | Will Hunt |  | Integrations / Element Matrix |
| SMHEI-19 | Documentation | Add Matrix hookshot user guide | new |  |  |  |

## Details

| Attribute | Value |
| --- | --- |
| Module |  |
| Enterprise plan |  |
| Labels |  |

## People

| Attribute | Value |
| --- | --- |
| Assignee | Will Hunt |
| Accountable |  |
| Product manager |  |
| Designer |  |
| Developers |  |
| Requested by |  |
| Interest by |  |

## Estimates and progress

| Attribute | Value |
| --- | --- |
| Work |  |

## Description

Creation of a very first version of Element/Matrix-OpenProject integration by modifying Matrix hookshot code, following similar structure as JIRA.

*   Hookshot is designed to be fairly generic and support multiple platforms
    
*   We get few things for "free" like widget support, command handlers, crypto support etc so it might be a nicer base to work on for the development of new integrations
    
*   A good starting point would be to go through the following code:
    
    <br>
    
    https://github.com/matrix-org/matrix-hookshot/tree/main/src/Connections. It has a bunch of examples of &quot;Connections&quot; which encapsulate how to integrate a new service with Hookshot.