summaryrefslogtreecommitdiff
path: root/docs/Hooks.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Hooks.md')
-rw-r--r--docs/Hooks.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/Hooks.md b/docs/Hooks.md
index 12e3ab7..bf6ea54 100644
--- a/docs/Hooks.md
+++ b/docs/Hooks.md
@@ -141,3 +141,28 @@ hooks:
```
Note the channel name must be in quotes.
+
+## Hook type: xmppdiff
+
+The `xmppdiff` hook posts config diffs to a [XMPP](https://en.wikipedia.org/wiki/XMPP) chatroom of your choice. It only triggers for `post_store` events.
+
+You will need to manually install the `xmpp4r` gem on your system:
+
+```
+gem install xmpp4r
+```
+
+Configuration example:
+
+``` yaml
+hooks:
+ slack:
+ type: xmppdiff
+ events: [post_store]
+ jid: "user@server.tld/resource"
+ password: "password"
+ channel: "room@server.tld"
+ nick: "nickname"
+```
+
+Note the channel name must be in quotes.