Setting up Airnotifier Push notification in Customized Moodle Mobile App


Considering that, we are building the mobile app from moodle mobile app codebase. In order to use the push notification feature using airnotifer, following steps are required.

Airnotifier Installation And Setups

app release version github tag :

airtnotifier version : 3

server environment : ubuntu

moodle version : 3.8

Airnotfier Setup

it requires python, so check the python version.

 >>> python --version

# make a directory to check the airnotifier from git, so lets say you are at home directory
>>> cd ~

## check out source code
>>> git clone -b master git:// 

# install python3 build tools
>>> apt-get install python3-pip build-essential git

# into checked out code directory
>>> cd airnotifier 

# setup python3 env
>>> pip3 install pipenv --user

# in my case, python3 was available with command python3
>>>  python3 -m pipenv install --deploy
>>> cp

# there is nothing to change as sample has everything. 
# it will require mongo db in order to run, if you do not have 
>>> echo "deb buster/mongodb-org/4.4 main" | sudo tee /etc/apt/sources.list.d/mongodb-org-4.4.list
 >>> sudo apt-get update
 >>> sudo apt-get install -y mongodb-org
 >>>  sudo apt-get install -y mongodb-org
 >>>  sudo systemctl start mongod
 >>>  sudo systemctl status mongod

# install airnotifier
>>> python3 -m pipenv run ./
>>> python3 -m  pipenv run ./

Imp-1 : make sure the port mentioned in /8801 is accessible from outside world , if not check ufw or firewall setting to allow port

Imp-2 : In order to run this without interrupting, you can utilize screen so that it run’s on virtual terminal that does not end after your session.

you can try accessing : In your browser: http://your_server_ip_address:8801 – Login as admin@airnotifier/admin

airnotifier dahsboard
Airtnoifier Screen

Create an app with the package name :-

google app console

Now , you need to do few more setup in regards of usage and that will depend upon the app type

Mobile App Configuration

Android App Configuration

  • In order to use this on Android Platform, you need to create a project in firebase.
  • Create a project and go to project settings
  • create an android app there and download google-service.json
google app console
  • Put that google-service.json in ionic moodle app codebase at root location [there are other files like config.xml, package.json etc]
  • Copy the project Id from Firebase Console project settings
google app console
  • put it under airnotifer “Firebase Cloud Messaging settings” section, project id and content of google-service.json

Now it is to setup the Moodle Codebase so that Notification can be pushed to Airnotifier.

IOs App Configuration

  • Key ID : <you can create and it will be available >
  • Key File [p8 content]:
app ios apn

Imp- IOs notification can not be tested on Emulator.

Setup Moodle and Airnotifier

  • under <moodleurl>/admin/message.php or Site administration > Messaging > Notification settings , enable Mobile Notification.
moodle enable airnotifier plugin
  • Click on Settings , and put the requried detail
    • Airtnotifier url, port number, package, airtnoifier app name [can be copied for airnotifier], Access key [ you can create that from air notifier app section]
moodle airtnotifier setting screen

So the setup part is done.

Important Points And How to Debug

Important Points

1- as this has custom package name, so please make sure you have changed this under Site administration > Mobile app > Mobile appearance Android app’s unique identifier section in moodle codebase

2- Android Notification can be tested on virtual device as well.

3: If your app crashes on receving notification while app is open

  • go to file message/output/airnotifier/message_output_airnotifier.php
  • edit file and go to line number 125, put the following code
    • unset($extra->notification);
$curl->setopt(array('CURLOPT_TIMEOUT' => 2, 'CURLOPT_CONNECTTIMEOUT' => 2));
// put the follwing line after above lines

How to Debug

  • As soon as you launch app , Server will register this. check the token from mdl_user_devices table
moodle device table
  • jsut try to send a message from admin to your app user from moodle interface and check in airtnotifer > <your app> > logs section.

if you get this , it means your moodle is communicating with Airnotifier Server. If not , it means there is problem as moodle is not able to push the message to airnotifer. jsut recheck moodle airnotifer setting again.


  1. I have done setup for Firebase Cloud Messaging settings (Project ID and JSON key). But when I tried to send broadcast message, nothing happened. FYI, when I tried to send message from firebase, my Moodle app can receive the notification. I think in somewhere, AirNotifier is unable to connect to Firebase. Do you have any suggestions what to check or where to see any logs? I have been struggling on this issue at least since last month.

    1. Not sure about your configuration, but you can run airnotifier from command line [pipenv run ./] and there will be logs.
      What i assume, you have successfully connected airotnotifer with moodle. ports are open and internet is available on aironotifier server.
      you try to send message from moodle.
      debugging :
      check the moodle logs [doign debuggin on ], if message is bradcasted using airnotifer and there is no issues
      check the airnotifer logs [coommand line will show the output if apis is being called]
      the check the logs under airnotifier web view

  2. Hey,

    I’m experiencing some problems getting Device Token on Android Mobile Custom App. I’m following this steps app -> App settings -> About -> Click at app version -> Push notification ID regarding to this documentation but the Device Token doesn’t show up.
    When I follow the same steps on IOS device the Token is showing correctly.

    Which can be the problem with Android?

    Thanks in advance!

    1. Hi Aldo, I have the same issue as you described in your post. I cannot get the device token on my Android custom app. Did you ever find a solution for this problem? I would appreciate your help. Thanks.

Leave a Reply

Your email address will not be published. Required fields are marked *