{"id":13554806,"url":"https://github.com/turt2live/matrix-appservice-webhooks","last_synced_at":"2025-03-16T20:31:41.582Z","repository":{"id":22537817,"uuid":"96630776","full_name":"turt2live/matrix-appservice-webhooks","owner":"turt2live","description":"Slack-compatible webhooks for matrix","archived":false,"fork":false,"pushed_at":"2024-04-18T12:34:49.000Z","size":396,"stargazers_count":102,"open_issues_count":42,"forks_count":23,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-02-27T13:36:17.524Z","etag":null,"topics":["appservice","bridge","emoji","matrix","slack","synapse","webhook"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/turt2live.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-08T16:30:30.000Z","updated_at":"2025-02-14T13:48:39.000Z","dependencies_parsed_at":"2024-01-14T16:10:56.397Z","dependency_job_id":"c3056762-5779-41fa-be7a-46251ea2d76a","html_url":"https://github.com/turt2live/matrix-appservice-webhooks","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/turt2live%2Fmatrix-appservice-webhooks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/turt2live%2Fmatrix-appservice-webhooks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/turt2live%2Fmatrix-appservice-webhooks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/turt2live%2Fmatrix-appservice-webhooks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/turt2live","download_url":"https://codeload.github.com/turt2live/matrix-appservice-webhooks/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243830922,"owners_count":20354850,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["appservice","bridge","emoji","matrix","slack","synapse","webhook"],"created_at":"2024-08-01T12:02:55.245Z","updated_at":"2025-03-16T20:31:41.165Z","avatar_url":"https://github.com/turt2live.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","emoji"],"sub_categories":[],"readme":"# Planned obsolescence \n\nCheck out [matrix-hookshot](https://github.com/Half-Shot/matrix-hookshot) as a replacement for this archaic bridge :)\n\n# matrix-appservice-webhooks\n\n[![TravisCI badge](https://travis-ci.org/turt2live/matrix-appservice-webhooks.svg?branch=master)](https://travis-ci.org/turt2live/matrix-appservice-webhooks)\n\nSlack-compatible webhooks for Matrix. Talk about it on Matrix: [#webhooks:t2bot.io](https://matrix.to/#/#webhooks:t2bot.io)\n\n# Usage\n\nInvite the webhook bridge to your room (`@_webhook:t2bot.io`) and send the message `!webhook`. The bridge bot will then send you a link to send messages to in a private message. You must be able to configure the room in order to set up webhooks.\n\n# JSON Body (for posting messages)\n\n```\n{\n  \"text\": \"Hello world!\",\n  \"format\": \"plain\",\n  \"displayName\": \"My Cool Webhook\",\n  \"avatarUrl\": \"http://i.imgur.com/IDOBtEJ.png\"\n}\n```\n\nFormat can be `plain` or `html`. Emoji will be converted automatically(`:heart:` becomes ❤); set the `emoji` property to `false` to disable this conversion.\nTo send a notice or emote, add `\"msgtype\" : \"notice\"` or `\"msgtype\" : \"emote\"` in your request.\n\n\n# Installation\n\n**Before you begin:** A matrix homeserver and Node 9 or higher are required.\n\n1. Clone this repository and install the dependencies\n   ```\n   git clone http://github.com/turt2live/matrix-appservice-webhooks\n   cd matrix-appservice-webhooks\n   npm install\n   ```\n\n2. Copy `config/sample.yaml` to `config/config.yaml` and fill in the appropriate fields\n3. Generate the registration file\n   ```\n   node index.js -r -u \"http://localhost:9000\" -c config/config.yaml\n   ```\n   *Note:* The default URL to run the appservice is `http://localhost:9000`. If you have other appservices, or other requirements, pick an appropriate hostname and port.\n\n4. Copy/symlink the registration file to your Synapse directory\n   ```\n   cd ~/.synapse\n   ln -s ../matrix-appservice-webhooks/appservice-registration-webhooks.yaml appservice-registration-webhooks.yaml\n   ```\n\n5. Add the registration file to your `homeserver.yaml`\n   ```\n   ...\n   app_service_config_files: [\"appservice-registration-webhooks.yaml\"]\n   ...\n   ```\n\n6. Restart Synapse (`synctl restart`, for example)\n\n# Running\n\nUsing the port specified during the install (`9000` by default), use `node index.js -p 9000 -c config/config.yaml -f appservice-registration-webhooks.yaml` from the repository directory.\n\nThe bridge should start working shortly afterwards.\n\n### Docker\n\nA Docker image of the bridge is available to host the bridge yourself. The image can be built yourself with `docker build -t matrix-appservice-webhooks .` or you can use the image on docker.io:\n```\ndocker run -p 9000:9000 -v /path/to/webhooks/dir:/data turt2live/matrix-appservice-webhooks\n```\n\nThe `/path/to/webhooks/dir` should have an `appservice-registration-webhooks.yaml` file, `config.yaml`, and `database.json`. Additional bridge-related data will be stored here.\n\n#### Example `appservice-registration-webhooks.yaml`\n\n```yaml\nid: webhooks\nhs_token: A_RANDOM_ALPHANUMERIC_STRING  # CHANGE THIS\nas_token: ANOTHER_RANDOM_ALPHANUMERIC_STRING  # CHANGE THIS\nnamespaces:\n  users:\n    - exclusive: true\n      regex: '@_webhook.*'\n  aliases: []\n  rooms: []\nurl: 'http://localhost:9002'  # you may need to change this (this should point at the bridge)\nsender_localpart: _webhook\nrate_limited: false\nprotocols: null\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fturt2live%2Fmatrix-appservice-webhooks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fturt2live%2Fmatrix-appservice-webhooks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fturt2live%2Fmatrix-appservice-webhooks/lists"}