-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the Redmine Webhook Plugin documentation!
The Redmine Webhook Plugin provides outbound webhook notifications for issues and time entries in Redmine. When events occur in Redmine (like creating, updating, or deleting an issue), the plugin sends HTTP POST requests to configured external endpoints, enabling integration with third-party systems like Slack, Microsoft Teams, Jira, custom dashboards, and more.
| Feature | Description |
|---|---|
| Issue Webhooks | Triggered on create, update, delete operations |
| Time Entry Webhooks | Triggered on time entry events |
| Event Filtering | Select which events trigger webhooks per endpoint |
| Multiple Payload Modes | minimal, standard, full for different use cases |
| Delivery Tracking | Monitor all webhook deliveries, view request/response |
| Retry Logic | Automatic retry with exponential backoff |
| Bulk Operations | Replay failed deliveries, export to CSV |
| Global Pause | Pause all webhook deliveries from settings |
| Admin UI | Full web interface for configuration and monitoring |
| Redmine 7+ Compatible | Automatically handles native webhooks to prevent duplicates |
| Version | Status | Notes |
|---|---|---|
| 5.1.0 | ✅ Supported | Minimum version |
| 5.1.10 | ✅ Supported | Tested |
| 6.1.0 | ✅ Supported | Tested |
| 7.0.0+ | ✅ Supported | Handles native webhooks |
- Redmine: 5.1.0 or higher
- Ruby: 3.x
- Database: SQLite, PostgreSQL, MySQL, MariaDB
- Web Server: Apache, Nginx, Puma, Unicorn (any Redmine-compatible)
- Network Access: Outbound HTTPS to webhook endpoints
# Using installer script (recommended)
sudo ./installer/install.sh -d /var/www/redmine -R -u www-data- Navigate to: Administration > Webhook Endpoints
- Click: New Webhook Endpoint
- Configure: Name, URL, Events, and click Save
- Create or update an issue in Redmine
- Check: Administration > Webhook Deliveries
- Verify: Delivery appears with status "Success"
This documentation is organized into the following sections:
- Getting Started - Installation and quick setup
- Configuration - Endpoint setup, event filtering, payload modes
- Usage Guide - Monitoring, replay, export operations
- Admin Interface - UI documentation for all admin pages
- Troubleshooting - Common issues and solutions
- Security - HTTPS, authentication, IP whitelisting
- API Reference - Complete payload structure reference
- Migration & Upgrades - Version compatibility and upgrade paths
Technical documentation is maintained in the Git repository:
-
docs/WIKI.md- Comprehensive technical reference (includes this wiki content) -
AGENTS.md- Developer guide and agent instructions -
docs/plans/- Implementation plans and design documents -
CHANGELOG.md- Version history and changes
See Installation for detailed installation instructions:
- Automated installer usage
- Manual installation steps
- Installation verification
- Uninstallation and cleanup
See Configuration for complete setup:
- Creating webhook endpoints
- Event filtering options
- Payload mode selection
- Global pause settings
- Advanced configuration
See Usage Guide for operational documentation:
- Monitoring webhook deliveries
- Replaying failed deliveries
- Exporting to CSV
- Bulk operations
- Purging old records
See Troubleshooting for:
- Common issues and solutions
- Debug mode configuration
- Log locations
- Error diagnosis
See API Reference for:
- Complete event payload structure
- Issue payload examples
- Time entry payload examples
- Response status codes
- Webhook signature options
Report bugs or request features:
- Plugin Wiki: This documentation (collaborative)
- Technical Docs: https://github.com/guyinwonder168/redmine_webhook_plugin
- Developer Guide: AGENTS.md
See CONTRIBUTING.md for guidelines on contributing to this plugin.
This plugin is licensed under the same terms as Redmine. See LICENSE for details.
Plugin Version: 1.0.0-RC1
Last Updated: 2026-02-03
Maintainer: Redmine Webhook Plugin Contributors