Event Trigger

Administration tools ::: tool_trigger

Maintained by

Catalyst IT

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.

Latest release: 5 months

710 sites

266 downloads

73 fans

Current versions available: 5

Download

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:

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

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

https://docs.moodle.org/dev/Event_2

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)

Get the code from GitHub or the Moodle Plugin Directory.
Copy or clone code into: <moodledir>/admin/tool/trigger
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:

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

Plugin Setup

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

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

Crafted by Catalyst IT

This plugin was developed by Catalyst IT:

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

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

Useful links

Screenshots

Contributors

Catalyst IT (Lead maintainer)

View other contributions

Aaron Wells

View other contributions

Matt Porritt

View other contributions

Dan Marsden

View other contributions

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

Awards

Early bird 3.5

Automated testing support

Privacy friendly

Comments

Show comments

Hussein Allaham
Fri, 21 Jan 2022, 6:11 PM
Hi

I'm trying to send users grade through HTTP post,
but in order to send them by HTTP post I have to add a token,
how to GET token through HTTP request and send it back as one of the parameter with the grades in POST HTTP request

Best
Hussein
Ben Girard
Wed, 6 July 2022, 2:43 AM
Does anyone know if installing this plugin in 4.0 will work.. We're forced to upgrade ASAP.
Dan Marsden
Wed, 6 July 2022, 3:43 AM
@ben - we're not aware of any reason it wouldn't but as always, latest version of our plugins are in github and please report any issues you find to our issues tracker.
bruno silva
Tue, 9 Aug 2022, 1:32 AM
Hello, I can see that this plugin is essential for those who need a more automated Moodle. However, I have a situation where I want to send an email to the student when he accesses the course certificate. I can get the course name through the plugin, but I can't get the username. The "Lookup Course" parameter works correctly. The parameter "Lookup User" I can't make it work. I have Moodle 3.11.5. Would it have anything to do with it?
Joe Drews
Sat, 4 Feb 2023, 2:35 AM
The User Lookup DOES NOT WORK as the last commentor said. We've looked at the source code and cannot seem to find what the problem is. THIS WILL NOT SEND EMAILS TO ENROLLED USERS IN ITS CURRENT STATE
Dan Marsden
Tue, 7 Feb 2023, 5:04 AM
@Joe - if you have internal development capabilities, feel free to do some further investigation and submit a pull request if you track it down! - otherwise we're in the process of re-developing this plugin here: https://github.com/catalyst/moodle-tool_dataflows

Feel free to try that one out and see if it works better for your needs!
Ritik Pathak
Mon, 27 Feb 2023, 5:50 PM
I'm done this for assignment grading but when i chose in action email the email should not be get i use {user_email}& also use user_lookup please sovle it fastly
Dan Marsden
Tue, 28 Feb 2023, 7:18 AM
@Ritik - as mentioned in the comments above, our main recent focus has been on a new plugin to replace this one called "tool_dataflows", however we welcome pull requests against the main tool_trigger repository if you have development capabilities and are able to help! - if not, you might want to try out our new plugin and see if it meets your needs. (it isn't published in the plugins db yet, only in github.)
Ritik Pathak
Tue, 28 Feb 2023, 3:52 PM
how to add a event fields in workflow steps
Ted Steinmann
Tue, 30 Jan 2024, 7:47 PM
I'm wondering if there is a way to make authenticated HTTP requests? In particular, I'd like to obtain and include a JWT to post course completions to my API. I spent some time looking around the repo and didn't see that in the works. Is that something that's possible already or would it need to be newly developed?
Krishna Mohan Prasad
Fri, 29 Mar 2024, 10:44 PM
Hi Devs,
Does this plugin work with Moodle 4.3. As i can't see any event to select as the workflow trigger.
Dan Marsden
Tue, 2 Apr 2024, 7:36 AM
@Krishna - we're not aware of any issues using this plugin in 4.3 - feel free to report any issues you find to the github issues tracker - our main focus has been on a replacement for this plugin called "dataflows" - feel free to check that out here: https://github.com/catalyst/moodle-tool_dataflows
Keenan Nunes-Vaz
Fri, 31 May 2024, 1:35 PM
Hi Devs,
I am trying to set up a workflow wherein a student is notified when a trainer manually grades their quiz attempt. I have tried looking at the events "Quiz attempt manual grading complete" and "Quiz grade updated" however in each of these cases, the only "available fields" are "wwwroot" are "wwwroot_domain". Does this mean that I cannot extract user/course data from this event? If not, does this mean my goal is a non-starter or is there another method you would suggest? thanks in advance for any help you can offer.
Toke Suhr
Wed, 5 Mar 2025, 5:11 AM
With this plugin would it be possible to add reminders before a course start - like 1, 3 and 7 days before the course start to all the participants for the course?
Dan Marsden
Wed, 5 Mar 2025, 5:25 AM
@Toke - this plugin relies on Moodle events - there is no Moodle event that occurs on a timeframe before course start so it can't take action. our newer plugin https://github.com/catalyst/moodle-tool_dataflows/ allows you to create workflows based on cron/scheduled tasks which might be able to do this, but there are various other simpler plugins that can trigger reminders based on dates - try asking in the forums for suggestions on this.