XMPP Webhook Bridge
Note that xmppwb is currently in early development and may contain bugs.
A bot that bridges XMPP (chats and MUCs) with webhooks, thus making it possible to interact with services outside the XMPP world. This can be used to connect XMPP to other chat services that provide a webhook API (for example Rocket.Chat or Mattermost).
Note: Python 3.5 is required. It will not work with Python 3.4 as xmppwb uses specific syntax that was introduced with Python 3.5.
xmppwb requires Python 3.5+ and can be installed using pip3:
$ pip3 install --upgrade xmppwb
which will automatically install the dependencies (aiohttp, pyyaml and slixmpp).
This bridge is meant to run on the same server as the application you are bridging with, as it currently uses HTTP for incoming webhooks.
To run the bridge:
$ xmppwb --config configfile.conf
$ python3 -m xmppwb --config configfile.conf
$ xmppwb -c CONFIG [-h] [-v] [-l LOGFILE] [-d] [--version]
See also xmppwb --help.
Please see CONFIGURATION.rst for detailed documentation. A simple config file looks like this (the <placeholders> need to be changed):
xmpp: # This JID must exist. jid: <firstname.lastname@example.org> password: "<bot-password>" # Define all MUCs that should be available to the bridges defined later. mucs: - jid: <email@example.com> nickname: <nickname> # password: "<muc-password>" incoming_webhook_listener: bind_address: "127.0.0.1" port: 5000 bridges: - xmpp_endpoints: - muc: <firstname.lastname@example.org> outgoing_webhooks: - url: <incoming-webhook-url-from-other-end> incoming_webhooks: - token: <outgoing-webhook-token-from-other-end>
Note that the password is stored in cleartext, so take precautions such as restricting file permissions. It is recommended to use a dedicated JID for this bridge.
The terminology incoming and outgoing in the config file refers to webhooks from the perspective of this bridge. The webhooks must also be defined on the other end (Rocket.Chat and Mattermost provide a UI for this, for example). An outgoing webhook in Rocket.Chat must be set up in the incoming webhooks section in this bridge and vice versa.
xmppwb is released under the MIT license. Please read LICENSE for details.