README

A powerful, production-ready Laravel package for tracking and distributing customer events to multiple marketing platforms with enterprise-grade reliability and security.

🆕 Version 2.0 - Complete rewrite with Domain-Driven Design, all bugs fixed, production-ready!

✨ Features

Core Features

🚀 Multi-Platform Support: Meta, Google, Brevo, TikTok, Pinterest, Snapchat
⚡ Asynchronous Processing: Queue-based event distribution
🎯 Event Mapping: Configure which platforms receive specific events
📊 MongoDB Logging: Track all events for analytics
🔧 Highly Configurable: Flexible configuration system

v2.0 New Features

🏗️ Domain-Driven Design: Clean, maintainable architecture
🔒 AES-256 Encryption: Secure credential storage
♻️ Auto-Retry: Exponential backoff (3 attempts)
🛡️ Circuit Breaker: Prevents cascading failures
🚦 Rate Limiting: Protects against API limits
💾 Smart Caching: 90% reduction in DB queries
🤖 Bot Detection: Filters out crawler traffic
🔐 SHA256 Hashing: Privacy-compliant PII handling
🌍 33 Currencies: Including AZN (Azerbaijani Manat) 🇦🇿
🐛 All Bugs Fixed: Meta, Google, Pinterest issues resolved
🗄️ SQL Support: MySQL, PostgreSQL, SQLite (in addition to MongoDB)
🔧 Extensible: Easy to add new platforms and events

Requirements

Core Requirements

PHP 8.2 or higher
Laravel 11.0 or higher
Queue driver (Redis, Database, etc.)

Optional Dependencies (Based on Your Setup)

Choose ONE credential storage method:

ENV Mode (Simplest): No extra dependencies needed ✅
SQL Mode: Uses Laravel's built-in database (MySQL/PostgreSQL/SQLite) ✅
MongoDB Mode: Requires composer require mongodb/laravel-mongodb

Platform-Specific (Install only what you use):

Meta/Facebook Pixel: Requires composer require facebook/php-business-sdk
Other platforms (Google, TikTok, etc.): Work out of the box with Guzzle HTTP client ✅

Note: Start with ENV mode for quick setup, upgrade to database mode when needed!

Installation

⚡ Quick Start (5 minutes - ENV Mode)

For simple setups without database configuration:

# Install core package
composer require mehdiyev-signal/pixel-manager

# Optional: Install Meta SDK if using Facebook/Meta Pixel
composer require facebook/php-business-sdk

Add credentials to .env:

PIXEL_MANAGER_DRIVER=env
PIXEL_META_PIXEL_ID=your_pixel_id
PIXEL_META_ACCESS_TOKEN=your_token

Done! See QUICK-START.md for details.

🗄️ MongoDB Mode Installation

# Install core package
composer require mehdiyev-signal/pixel-manager

# Install MongoDB driver
composer require mongodb/laravel-mongodb

# Optional: Meta SDK
composer require facebook/php-business-sdk

💾 SQL Mode Installation

# Install core package (SQL support built-in with Laravel)
composer require mehdiyev-signal/pixel-manager

# Optional: Meta SDK
composer require facebook/php-business-sdk

📚 Full Installation

For multi-environment or advanced setups:

composer require mehdiyev-signal/pixel-manager

Upgrading from v1.x? See UPGRADE-2.0.md for migration guide.

Publish the configuration file:

php artisan vendor:publish --tag=pixel-manager-config

Optionally, publish the migration files:

php artisan vendor:publish --tag=pixel-manager-migrations
php artisan migrate

Configuration

Environment Variables

Add the following to your .env file:

# Basic Configuration
PIXEL_MANAGER_APP_ID=40
PIXEL_MANAGER_DB_CONNECTION=mongodb
PIXEL_MANAGER_COLLECTION=mp_customer_event
PIXEL_MANAGER_QUEUE=default
PIXEL_MANAGER_LOGGING=true

# v2.0 Performance Features
PIXEL_MANAGER_CACHE_ENABLED=true
PIXEL_MANAGER_CACHE_TTL=3600
PIXEL_MANAGER_RETRY_ENABLED=true
PIXEL_MANAGER_RETRY_MAX_ATTEMPTS=3

# v2.0 Resilience Features
PIXEL_MANAGER_CIRCUIT_BREAKER_ENABLED=true
PIXEL_MANAGER_CIRCUIT_BREAKER_THRESHOLD=5
PIXEL_MANAGER_RATE_LIMITING_ENABLED=true
PIXEL_MANAGER_RATE_LIMIT=100

# v2.0 Security Features
PIXEL_MANAGER_ENCRYPT_CREDENTIALS=true
PIXEL_MANAGER_BOT_DETECTION=true

# MongoDB Connection
DB_CONNECTION=mongodb
DB_DSN=mongodb://localhost:27017
DB_DATABASE=your_database

Platform Credentials

Store your platform credentials in MongoDB's applications collection:

db.applications.insertOne({
    app_id: 40,
    category: "customer_event",
    data: {
        // Meta Pixel
        meta_pixel_id: "YOUR_META_PIXEL_ID",
        meta_access_token: "YOUR_META_ACCESS_TOKEN",

        // Google Analytics 4
        google_measurement_id: "YOUR_GA4_MEASUREMENT_ID",
        google_api_secret: "YOUR_GA4_API_SECRET",

        // Brevo
        brevo_api_key: "YOUR_BREVO_API_KEY",

        // TikTok
        tiktok_pixel_code: "YOUR_TIKTOK_PIXEL_CODE",
        tiktok_access_token: "YOUR_TIKTOK_ACCESS_TOKEN",

        // Pinterest
        pinterest_account_id: "YOUR_PINTEREST_ACCOUNT_ID",
        pinterest_access_token: "YOUR_PINTEREST_ACCESS_TOKEN",

        // Snapchat
        snapchat_pixel_id: "YOUR_SNAPCHAT_PIXEL_ID",
        snapchat_access_token: "YOUR_SNAPCHAT_ACCESS_TOKEN"
    }
})

Event Mapping

Configure which platforms receive specific events in config/pixel-manager.php:

'event_mappings' => [
    'purchase' => ['meta', 'google', 'tiktok', 'brevo', 'pinterest', 'snapchat'],
    'add_to_cart' => ['meta', 'google', 'tiktok', 'brevo', 'pinterest', 'snapchat'],
    'view_item' => ['meta', 'google', 'tiktok', 'brevo'],
    'search' => ['meta', 'google'],
    // Add more event mappings...
],

Usage

Basic Usage

Use the Facade to track events:

use MehdiyevSignal\PixelManager\Presentation\Facades\PixelManager;

PixelManager::track([
    'data' => [
        'event_type' => 'purchase',
        'event' => 'purchase',
        'transaction_id' => 'TXN123456',
        'order_id' => 'ORD789',
        'value' => 99.99,
        'currency' => 'USD',
        'shipping' => 5.00,
        'customer' => [
            'email' => 'customer@example.com',
            'external_id' => 'user_12345',
            'first_name' => 'John',
            'last_name' => 'Doe',
            'phone' => '+1234567890',
            'city' => 'New York',
            'state' => 'NY',
            'country_code' => 'US',
            'zip_code' => '10001',
        ],
        'items' => [
            [
                'item_id' => 'PROD123',
                'item_name' => 'Premium Widget',
                'price' => 49.99,
                'quantity' => 2,
                'category' => 'Electronics',
                'item_brand' => 'BrandName',
            ]
        ]
    ]
]);

In a Controller

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use MehdiyevSignal\PixelManager\Presentation\Facades\PixelManager;

class EventController extends Controller
{
    public function track(Request $request)
    {
        PixelManager::track($request->all());

        return response()->json(['success' => true]);
    }
}

Check Platform Status

// Get all supported platforms
$platforms = PixelManager::platforms();
// Returns: ['meta', 'google', 'brevo', 'tiktok', 'pinterest', 'snapchat']

// Check if a platform is enabled
if (PixelManager::isPlatformEnabled('meta')) {
    // Meta pixel is configured and enabled
}

Supported Events

The package supports the following standard events:

Event Type	Description	Platforms
`purchase`	Completed purchase	All
`add_to_cart`	Product added to cart	All
`view_item`	Product viewed	All
`begin_checkout`	Checkout started	All
`view_cart`	Shopping cart viewed	All
`search`	Search performed	All
`add_payment_info`	Payment info added	All
`add_to_wishlist`	Item added to wishlist	All
`page_view`	Page viewed	All
`completed_registration`	User registration	All
`subscription`	Subscription created	All
`customize_product`	Product customization	Meta only

Platform-Specific Features

Meta Pixel

Server-side event tracking
Automatic user data hashing
FBC/FBP tracking support
Full Facebook Business SDK integration

Google Analytics 4

Measurement Protocol v2
Standard GA4 event names
Rich e-commerce data
Client ID and User ID support

Brevo

Contact identification (email, WhatsApp, external ID)
Contact properties tracking
Event properties with cart data
Real-time CRM updates

TikTok, Pinterest, Snapchat

Server-side conversion tracking
Product catalog integration
Advanced event parameters
Audience building support

Queue Configuration

The package uses Laravel's queue system for asynchronous processing. Make sure to configure your queue driver:

QUEUE_CONNECTION=redis
PIXEL_MANAGER_QUEUE=pixel-events

Run the queue worker:

php artisan queue:work --queue=pixel-events

Event Logging

All events are logged to MongoDB for analytics and debugging. Access logs through the CustomerEventModel:

use MehdiyevSignal\PixelManager\Infrastructure\Persistence\MongoDB\Models\CustomerEventModel;

$events = CustomerEventModel::where('event_name', 'purchase')
    ->where('created_at', '>=', now()->subDay())
    ->get();

Testing

Run the test suite:

composer test

With coverage:

composer test-coverage

Troubleshooting

Events Not Being Sent

Check queue worker is running
Verify platform credentials in MongoDB
Check storage/logs/laravel.log for errors
Ensure event type is mapped in config

MongoDB Connection Issues

# Verify MongoDB extension is installed
php -m | grep mongodb

# Test connection
php artisan tinker
>>> DB::connection('mongodb')->getMongoDB()->listCollections()

Platform-Specific Issues

Check individual platform action logs:

tail -f storage/logs/laravel.log | grep "Brevo\|Meta\|Google"

Getting Started

⚡ Quick Start - Get started in 5 minutes without database
🔑 APP_ID Guide - Understand application ID configuration
🧪 Testing Guide - Comprehensive testing documentation

Extensibility

Want to add a new platform, customize behavior, or override components? The package is fully extensible!

Extensibility Guide - How to add new platforms, events, and decorators
Override Guide - How to customize and override package behavior
SQL Setup Guide - How to use SQL instead of MongoDB

The DDD architecture makes it easy to extend and override without modifying core code.

Security

If you discover any security-related issues, please email s.mehdiyev1997@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Support

For support, please open an issue on GitHub Issues or contact s.mehdiyev1997@gmail.com.

mehdiyev-signal / pixel-manager

Maintainers

Details