Installation

Requirements

• Craft CMS 5.0 or later
• PHP 8.2 or later

Freeform is optional. If Solspace Freeform (5.x) is installed, a Freeform submission source appears automatically; if it isn't, that source is simply hidden and nothing else changes.

Install with Composer

From your project root, require the plugin and then install it:

composer require coysh-digital/craft-webhook-notifier
php craft plugin/install webhook-notifier

Install from the Plugin Store

Or install it from the Plugin Store in your control panel: search for "Webhook Notifier", then click Install.

After installing

You'll find Webhook Notifier in the control panel's main navigation, with sub-sections for Rules, Connections, Logs and (for admins) Settings.

Nothing is sent until you've set up a rule, so a first pass looks like this:

1. Create a connection. A connection is the destination - a webhook URL. Head to Webhook Notifier → Connections → New, paste your URL (or an environment-variable reference), and use Send a test to confirm it works. See Connections.
2. Create a rule. A rule joins a trigger to that connection and a payload. Go to Webhook Notifier → Rules → New, pick a source, choose the connection, and build the card or payload. See Rules.
3. Watch the log. Open Webhook Notifier → Logs to see each attempt, what was sent, and what the webhook returned. See Delivery log.

If you're sending to Microsoft Teams, the Microsoft Teams page walks through creating the workflow and getting its URL. If you're sending anywhere else, Payloads and cards covers the raw payload format.

Permissions

Access is controlled by three user permissions, under Webhook Notifier in a user group's or user's permissions:

• Manage notification rules
• Manage connections - connections store webhook URLs, which are secrets, so this is worth restricting.
• View the delivery log

Settings are admin-only.

Uninstalling

Uninstall from Settings → Plugins, or with:

php craft plugin/uninstall webhook-notifier

There's nothing left behind on your front end to clean up.

Uninstalling takes your data with it

Uninstalling drops the plugin's tables, which means your rules, your connections and the whole delivery log. Export anything you want to keep first.