ph-f / mod_offline_http_post

Ejabberd 17.01 module to send offline user's message via POST request to target URL

Ejabberd 18.06+ module to send offline user's message via POST request to target URL. This module can call an api to send e.g. a push message. The request body is in application/x-www-form-urlencoded format. See the example below.

V17.01 Forked from Nimrodda/mod_offline_http_post ejabberd 16.08

V17.04 updated and tested in 17.04, I assume it works in 17.03 also.

V19.02 updated and tested in 19.02, I assume it works in 18.06, 18.09 and 18.12 also.

Installation

1. cd /opt/ejabberd-19.02/.ejabberd-module/sources/
2. git clone https://github.com/PH-F/mod_offline_http_post.git;
3. bash /opt/ejabberd-19.02/.ejabberd-module/bin/ejabberdctl module-install mod_offline_http_post
4. /etc/init.d/ejabberd restart;

That's it. The module is now installed.

Configuration

Add the following to ejabberd configuration under modules:

mod_offline_http_post:
    auth_token: "secret"
    post_url: "http://example.com/notify"
    confidential: true

• auth_token - user defined, hard coded token that will be sent as part of the request's body. Use this token on the target server to validate that the request arrived from a trusted source.
• post_url - the server's endpoint url
• confidential - boolean parameter; if true, do not send the message body in post data. if false (default), send the message body.

Example of the outgoing request:

array(5) {
  ["to"]=>
  string(11) "testuser"
  ["from"]=>
  string(7) "patrick"
  ["vhost"]=>
  string(16) "server.myserver.nl"
  ["body"]=>
  string(7) "This is a testmessage"
  ["messageId"]=>
  string(13) "purple3838f2f"
}