Skip to content

CiviCRM extension to provide a Slack notification action for CiviRules rules.

License

Notifications You must be signed in to change notification settings

ChrisHardie/civicrm-slack-notifications

Repository files navigation

Slack Notifications for CiviCRM

This extension enables a CiviRules action that allows CiviCRM to send notifications to Slack.

The extension is beta software, and may not be suitable for a production environment. Issues and pull requests welcome.

The extension is licensed under AGPL-3.0.

Requirements

  • PHP v7.2+
  • CiviCRM 5+
  • CiviRules 2.23+
  • Command line access for composer install

Installation (Web UI)

Learn more about installing CiviCRM extensions in the CiviCRM Sysadmin Guide.

Installation (CLI, Zip)

Sysadmins and developers may download the .zip file for this extension and install it with the command-line tool cv.

cd <extension-dir>
cv dl com.chrishardie.slacknotifications@https://github.com/ChrisHardie/civicrm-slack-notifications/archive/master.zip

Installation (CLI, Git)

Sysadmins and developers may clone the Git repo for this extension and install it with the command-line tool cv.

git clone https://github.com/ChrisHardie/civicrm-slack-notifications.git com.chrishardie.slacknotifications
cv en com.chrishardie.slacknotifications

(The cv en command does not appear to be valid for WordPress installs.)

Getting Started

You may need to do a composer install to get required libraries in place.

Follow Slack's documentation to set up an Incoming Webhook and get the URL.

Navigate to Administer -> System Settings -> Slack Notification Settings and paste in the Incoming Webhook URL.

Create or update a CiviRules rule to use the "Slack Notification Action."

Known Issues

  • This is the author's first CiviCRM extension and probably contains errors or failures to adhere to best practices.
  • Configuration of the Slack message icon and name must be done in the Incoming Webhook settings.
  • Token support in the Slack message template is limited.

About

CiviCRM extension to provide a Slack notification action for CiviRules rules.

Resources

License

Stars

Watchers

Forks