Module description

This module enables forwarding certain events (messages, presence, etc.) via HTTP to external services such as push (by mobile, email or SMS), big data, or analytics services.

How it works

The module adds a handler to a user_send_packet hook which is triggered every time a user sends anything. When the hook is triggered, the module:

  • checks whether http_notification is enabled (the host param is set)
  • runs a callback module's should_make_req/3 function to see if a notification should be sent
  • sends a POST request composed of {Host::binary(), Sender::binary(), Receiver::binary(), Message::binary()} to the http notification server

Callback module

To find out what should be sent to the HTTP server, MongooseIM calls Mod:should_make_req(Packet::xmlel(), From::jid(), To::jid()). By default it uses the function in mod_http_notification itself, which ships all non-empty chat messages and nothing else. The module can be substituted here, the method should return true | false.

Prerequisites

This module uses a connection pool created by mongoose_http_client. It must be defined in http_connections settings.

Options

  • pool_name: name of the pool to use (as defined in http_connections)
  • path: path part of an URL to which a request should be sent (will be appended to the pool's prefix path).
  • callback_module: name of a module which should be used to check whether a notification should be sent.

Example configuration

{http_connections, [{http_pool, [{server, "http://localhost:8000"}, {pool_size, 50}, {path_prefix, "/webservice"}]} ]}.

{mod_http_notification, [{pool_name, http_pool}, {path, "/notifications"}]}

Notifications will be POSTed to http://localhost:8000/webservice/notifications.

Metrics

If you'd like to learn more about metrics in MongooseIM, please visit MongooseIM metrics page.

Name Type Description (when it gets incremented)
[Host, mod_http_notifications, sent] spiral An HTTP notification is sent successfully.
[Host, mod_http_notifications, failed] spiral An HTTP notification failed.
[Host, mod_http_notifications, response_time] histogram Does not include timings of failed requests.