🚀 Hooketh: A Webhook Management Platform

A comprehensive, enterprise-grade webhook management and delivery platform built with Laravel and Vue.js

Features • Quick Start • Documentation • Contributing • License

---

✨ Features

Core Functionality

• 🎯 Endpoint Management - Create and manage webhook endpoints with security configurations
• 📦 Event Processing - Handle various event types with structured payloads
• 🔄 Reliable Delivery - Automatic retry mechanisms with exponential backoff
• 📊 Real-time Monitoring - Track delivery status, response codes, and performance metrics
• 🔐 Security First - HMAC signature verification and secret key management
• ⚡ Queue Processing - Background job processing for high-volume webhook delivery

Management & Analytics

• 📈 Dashboard & Analytics - Comprehensive delivery statistics and success rates
• 🔍 Advanced Filtering - Search and filter events by type, status, date range
• 📝 Detailed Logging - Complete audit trail of webhook attempts and responses
• 🎛️ Admin Controls - Endpoint activation/deactivation and configuration management
• 💾 Data Export - Export delivery logs and analytics data

Technical Features

• 🚄 High Performance - Built on Laravel with Redis caching and queue optimization
• 🏗️ Scalable Architecture - Docker containerization with horizontal scaling support
• 🔧 Developer Friendly - Comprehensive API, detailed documentation, and testing utilities
• 📧 Email Notifications - Delivery failure alerts and status notifications

🚀 Quick Start

Prerequisites

• Docker and Docker Compose
• Node.js (for frontend development)
• Git

Installation

1. Clone the repository

   git clone https://github.com/morcen/hooketh.git
   cd webhook-management-platform

2. Set up environment configuration

   # Copy the example environment file
   cp .env.example .env
   
   # Generate application key
   php artisan key:generate

   Important: The Docker setup now uses your local .env file instead of a separate Docker environment file. Make sure your .env file is properly configured before building containers.

3. Start with Docker (Recommended)

   # Build and start all services
   make setup
   
   # Or manually:
   docker-compose up -d
   make migrate
   make seed

4. Access the application

   • Web Interface: http://localhost:8080
   • API Documentation: http://localhost:8080/api/docs
   • Email Testing: http://localhost:8025 (MailHog)

5. Default Login

   • Email: test@example.com
   • Password: password

Development Setup

For Vue.js development with hot reloading:

# Install Node.js dependencies
npm install

# Start Vite development server
npm run dev

See DEVELOPMENT.md for detailed development instructions.

📚 Documentation

• Development Guide - Detailed development setup and workflows
• Docker Documentation - Docker setup, commands, and configuration
• Deployment Guide - Cloud deployment instructions and troubleshooting
• API Documentation - REST API endpoints and examples
• Architecture Overview - System design and components

🛠️ Tech Stack

• Backend: Laravel 12, PHP 8.2+
• Frontend: Vue.js 3, Inertia.js, Tailwind CSS
• Database: PostgreSQL
• Cache & Queue: Redis
• Web Server: Nginx
• Build Tool: Vite
• Containerization: Docker & Docker Compose

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Quick Contribution Steps

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Add tests for your changes
5. Commit your changes (git commit -m 'Add amazing feature')
6. Push to the branch (git push origin feature/amazing-feature)
7. Open a Pull Request

🐛 Issues & Support

• Bug Reports: Create an issue
• Feature Requests: Create an issue
• Questions: Discussions

🔐 Security

If you discover a security vulnerability, please send an email to security@yourproject.com instead of using the issue tracker. All security vulnerabilities will be promptly addressed.

📄 License

This project is open-sourced software licensed under the MIT license.

🙏 Acknowledgments

• Built with Laravel
• UI components by Tailwind CSS
• Frontend framework by Vue.js
• Thanks to all contributors

---

Made with ❤️ for the developer community