matrix-appservice-webhooks

Slack-compatible webhooks for Matrix. Talk about it on Matrix: #webhooks:t2bot.io

Requirements

NodeJS (Node 6 or higher recommended)
A Synapse server

Installation

Before you begin: A Synapse server is required. The instructions here assume that Synapse server is a default setup.

Clone this repository and install the dependencies

git clone http://github.com/turt2live/matrix-appservice-webhooks
cd matrix-appservice-webhooks
npm install

Copy config/sample.yaml to config/config.yaml and fill in the appropriate fields
Generate the registration file
```
node index.js -r -u "http://localhost:9000" -c config/config.yaml
```
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.

Copy/symlink the registration file to your Synapse directory

cd ~/.synapse
ln -s ../matrix-appservice-webhooks/appservice-registration-webhooks.yaml appservice-registration-webhooks.yaml

Add the registration file to your homeserver.yaml

...
app_service_config_files: ["appservice-registration-webhooks.yaml"]
...

Restart Synapse (synctl restart, for example)

Running

Using the port specified during the install (9000 by default), use node index.js -p 9000 -c config/config.yaml from the repository directory.

The bridge should start working shortly afterwards.

Usage

Invite 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.

JSON Body (for posting messages)

{
  "text": "Hello world!",
  "format": "plain",
  "displayName": "My Cool Webhook",
  "avatarUrl": "http://i.imgur.com/IDOBtEJ.png"
}

Format can be plain or html. Emoji will be converted automatically(:heart: becomes ❤); set the emoji property to false to disable this conversion. To send a notice or emote, add "msgtype" : "notice" or "msgtype" : "emote" in your request.