Admin tools: Event Trigger

tool_trigger
Maintained by Picture of Catalyst ITCatalyst IT, Catalyst logoAaron Wells, Picture of Matt PorrittMatt Porritt, Picture of Dan MarsdenDan Marsden
This plugin plugin allows site administrators to trigger external actions such as an http request or email when certain events happen in Moodle. Filters can be added to check if the event meets certain conditions and actions(email/http post) can include information contained within the Moodle event. Lookups can also be added to the workflow to allow information not contained within the Moodle event to be exposed to the external action.
258 sites
211 downloads
35 fans
Current versions available: 2

Event Trigger

The Event Trigger allows Moodle Events to be monitored and a workflow to be triggered when that event occurs.
One of the main use cases of this plugin is to allow Moodle events to trigger actions in external systems.

Each workflow is made up of a series of steps. Steps can be things like:

  • Using event data to lookup user and course information
  • Filtering data based on a set of conditions
  • Performing an action like sending an email or Posting data to a HTTP endpoint or external API.

More configuration documentation can be found at the following link:

More Information on Moodle events can be found in the Moodle documentation at the following link:


Supported Moodle Versions

This plugin currently supports Moodle:

  • 3.3 (PHP 7 is required)
  • 3.4
  • 3.5

Moodle Plugin Installation

The following sections outline how to install the Moodle plugin.

Command Line Installation

To install the plugin in Moodle via the command line: (assumes a Linux based system)

  1. Get the code from GitHub or the Moodle Plugin Directory.
  2. Copy or clone code into: <moodledir>/admin/tool/trigger
  3. Run the upgrade: sudo -u www-data php admin/cli/upgrade Note: the user may be different to www-data on your system.

User Interface Installation

To install the plugin in Moodle via the Moodle User Interface:

  1. Log into your Moodle as an Administrator.
  2. Navigate to: Site administration > Plugins > Install Plugins
  3. Install plugin from Moodle Plugin directory or via zip upload.

Plugin Setup

Plugin setup and configuration documentation can be found at the following link:


Crafted by Catalyst IT

This plugin was developed by Catalyst IT:

https://www.catalyst-au.net/

Catalyst IT

Contributing and Support

Issues, and pull requests using github are welcome and encouraged!

https://github.com/catalyst/moodle-tool_trigger/issues

If you would like commercial support or would like to sponsor additional improvements to this plugin please contact us:

https://www.catalyst-au.net/contact-us


Screenshots

Screenshot #0
Screenshot #1
Screenshot #2
Screenshot #3

Contributors

Please login to view contributors details and/or to contact them

Comments RSS

Show comments
  • Picture of Dan Marsden
    Fri, Aug 10, 2018, 5:04 AM
    yeah - that's the version in the plugins db here, but the code has moved on a lot since then - latest code is all in github - probably worth giving the code from github a go to see if that works better for you.
  • Picture of Brandon Jimenez
    Fri, Aug 10, 2018, 11:25 PM
    Hello Dan: I updated to the latest version you have on github and habe news: now the workflow i created to track the user logging in is working, but the one for the password change isn't. I know it's being triggered (the event) as both the Last triggered column in your plugin and the core event changes (i'm receiving an email from the core in that event). I also have basically the same actions in both, using mostly the same info. Is there something else i could look up for? Also, it's a little bit bizarre that when we update the workflow, the last triggered column goes blank (i understand the logic, but it would be worth mentioning it in the wiki). As usual, best regards.
  • Picture of Dan Marsden
    Mon, Aug 13, 2018, 5:40 AM
    Sounds weird - thanks for the update, let us know if you figure it out! - thanks.
  • Picture of Ketan Chandaria
    Fri, Aug 24, 2018, 4:10 PM
    Hello Dan: I'm intending to trigger emails to go out to various user groups upon certain activity occurring. In assignment activity, I have set up assignment to use multiple markers (non-editing teacher role) and marking flow (in marking, marking completed, in review, released, etc..). Each marker can see / action only their allocated students. The emails should trigger in these scenario (A) to student and their respective marker only on assignment submission (B) to student, resp. marker and resp. teacher on assignment status 'marking completed' (C) to student, resp. marker and resp. teacher on assignment status 'grade released'
    Can you / someone please help me with how to config this plugin and maybe assignment setting. I'm using moodle 3.4 & php 7. Thank you so much.
  • Picture of Dan Marsden
    Fri, Aug 24, 2018, 5:05 PM
    Hi Ketan, unfortunately we are not in a position to provide free support for everyone that wants help configuring this plugin with a specific workflow - and the comments here in the plugin database don't make this easy either (no threads etc.) - You could try asking for help in the community forums and one of our team might notice the post and have time to reply, otherwise you're on your own at this stage sorry! - good luck!
  • Picture of Brandon Jimenez
    Fri, Aug 31, 2018, 2:15 AM
    Hi Dan, we finally fixed it! There was a missed setting in the mail server. Thanks for all the help.
  • Ben Haensel
    Tue, Oct 9, 2018, 3:33 AM
    Could anyone offer advice as to what I'm missing when setting up this event trigger for a specific student when submitting a quiz? Please see linked image: https://goo.gl/4uiwcm

    Thanks for any info! -Ben, ben@blueskyschool.org
  • Picture of King Hernandez
    Wed, Nov 21, 2018, 12:20 PM
    Hi Catalyst team!

    Is it possible to send multiple recipients with the email action trigger?
    Regards.
  • Picture of Roberto Hebert de Souza Vinha
    Tue, Feb 19, 2019, 5:01 AM
    For Action Step Type not appear any Step.
  • Picture of Dan Logan
    Fri, Mar 15, 2019, 12:07 PM
    This is an excellent plugin. Not much documentation so I'd love to add to it with my samples but not sure how to
  • Picture of Scott Haugsjaa
    Sat, Nov 23, 2019, 6:00 AM
    I use this plugin to add groups of users to our Moodle environment. Is it possible to add something to our CSV upload template that, if added, will prevent an event trigger from happening? For more context, we use Event Trigger to automatically email users a "Welcome" email with their Username and Password. In some scenarios we may -not- want to send this email.
  • Picture of Yannick Vrolant
    Sun, Feb 23, 2020, 12:05 AM
    Hi,

    I am not sure whether this plugin could meet my needs. Here are the details of 2 use cases :

    Case #1 : Automatically notify users via the web interface (not by e-mail) whenever a new glossary entry is added

    I am using a glossary activity on our frontpage as a knowledge base in which I regularly post tutorials on how to use the Moodle platform and its functionalities.

    I have created an event monitoring rule for any new glossary entry and applied it to this glossary. I have subscribed myself to this rule under the notification preferences and it does work : I do get notifications (both via the web interface as well as by e-mail).

    However, this only works for myself as I "opted in" to receive such notifications in the first place.

    Now, I would like all users on the platform to be automatically subscribed to such alerts by default, without lifting a finger (people should then be able to unsubscribe from these alerts if they so wish).

    The end result should work like forum activities in which users might be automatically subscribed but might also choose to unsubscribe if they wish to. Is this something your plugin could help with ?

    Case #2 : automatically notify teachers whenever a new glossary entry is pending approval

    Our teachers would love it if they could get notified by e-mail and / or through the web interface whenever a student has added a new glossary entry for approval.

    Would you say this plugin could help with any if both of these cases ?

    Thanks for helping !
    Best,

    Yannick
  • Picture of Michelle Jay
    Sat, Apr 25, 2020, 12:10 AM
    Hello - Thank you for creating such a great plugin! Question: is it possible to HTTP Post to a Zapier webhook with this plugin? I have created a workflow and entered a Zapier webhook into the HTTP post action, but it doesn't seem to be working (Zapier isn't receiving anything). It does work with the Tool Trigger plugin by Justin, but I like your plugin's ability to filter before sending to Zapier. Would appreciate any help!
  • Picture of Paul Vincent
    Tue, May 5, 2020, 3:38 PM
    Firstly, many thanks for this invaluable plugin - it's fixed a number of issues we had at a single stroke! There's one minor issue that I've been unable to get my head around though; we're sending emails as an action, and they work perfectly - no issues at all, but when making an httppost to an MS Teams connector, the Moodle Event variables are not decoding but the rest of the message text is. This is our Parameters entry:

    {"text":"Assignment has been graded by {user_firstname} {user_lastname} ({user_email}) in the course unit: {course_fullname}. Direct link to Assignment Feedback: https://learn.oca.ac.uk/mod/assign/view.php?id={contextinstanceid}&rownum=0&action=grader&userid={relateduserid}
    "}

    With Header: Content-Type: application/json; charset=UTF-8

    ...and it comes through to MS Teams as: Assignment has been graded by Paul Vincent (paulvincent%40oca.ac.uk) in the course unit: Assessment+Test. Direct link to Assignment Feedback: https://vletest.oca.ac.uk/mod/assign/view.php?id=6943&rownum=0&action=grader&userid=19

    Am I missing something very obvious? When I try escaping the event variables or ticking the encode json option, no message at all comes through. Not a major issue, as we'll likely be using email in any case, but would appreciate any tips!
  • Picture of Jim Valentine
    Mon, Jul 6, 2020, 11:48 PM
    Hello,

    I would like to set up an event trigger on course completion - which appears easily done. The only problem I have is that I wish to trigger different actions for course completion on different courses. Is this possible with this plugin?

    Regards
1 2
Please login to post comments