PHPackages xavicabot/filament-activecampaign - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. xavicabot/filament-activecampaign ActiveLibrary[API Development](/categories/api) xavicabot/filament-activecampaign ================================= Filament plugin for ActiveCampaign integration v2.1.0(1mo ago)1484↓89.9%MITPHPPHP ^8.2CI passing Since Dec 9Pushed 1mo agoCompare [ Source](https://github.com/xavicabot/filament-activecampaign)[ Packagist](https://packagist.org/packages/xavicabot/filament-activecampaign)[ RSS](/packages/xavicabot-filament-activecampaign/feed)WikiDiscussions main Synced 4d ago READMEChangelog (6)Dependencies (12)Versions (18)Used By (0) Filament ActiveCampaign ======================= [](#filament-activecampaign) Advanced ActiveCampaign integration for **Laravel** and **FilamentPHP 3**, focused on developer productivity. This package allows you to: - Sync **Lists**, **Tags** and **Custom Fields** from ActiveCampaign - Create **Automations** based on **custom events** (`user.registered`, `wallet.first_deposit`, etc.) - Subscribe contacts to Lists - Add Tags - Update Custom Fields - Update System Fields (`firstName`, `lastName`, `phone`, etc.) - Use dynamic templating (`{user.*}`, `{ctx.*}`, `{now}`, etc.) - Log every automation execution (success, payload, warnings, errors) - Preview the execution plan before running an automation - Manage everything visually from FilamentPHP --- πŸ”§ Installation -------------- [](#-installation) Install via Composer: ``` composer require xavicabot/filament-activecampaign ``` Publish config and migrations: ``` php artisan vendor:publish --provider="XaviCabot\FilamentActiveCampaign\ActiveCampaignServiceProvider" --tag=activecampaign-config php artisan vendor:publish --provider="XaviCabot\FilamentActiveCampaign\ActiveCampaignServiceProvider" --tag=activecampaign-migrations php artisan migrate ``` --- βš™οΈ Configuration ---------------- [](#️-configuration) Add your ActiveCampaign credentials to `.env`: ``` ACTIVECAMPAIGN_BASE_URL="https://YOUR_ACCOUNT.api-us1.com" ACTIVECAMPAIGN_API_KEY="your-api-key" ``` Published config file: ``` config/activecampaign.php ``` --- πŸ”„ Syncing Metadata (Lists, Tags, Fields) ---------------------------------------- [](#-syncing-metadata-lists-tags-fields) This package stores ActiveCampaign metadata locally: - `activecampaign_lists` - `activecampaign_tags` - `activecampaign_fields` ### Sync everything [](#sync-everything) ``` php artisan activecampaign:sync-metadata ``` Or individually: ``` php artisan activecampaign:sync-metadata --lists php artisan activecampaign:sync-metadata --tags php artisan activecampaign:sync-metadata --fields ``` ### From Filament [](#from-filament) The Automations resource includes a **"Sync metadata"** button to refresh lists/tags/fields without CLI access. --- 🏷️ Creating Tags ---------------- [](#️-creating-tags) You can create new tags either from the Filament UI or programmatically from your code. ### From Filament UI [](#from-filament-ui) 1. Navigate to **ActiveCampaign Tags** in Filament 2. Click the **"Create Tag"** button in the header 3. Fill in the form: - **Tag Name** (required) - The name as it will appear in ActiveCampaign - **Description** (optional) - Internal reference note (only used when creating new tags) 4. Submit **Smart behavior:** If the tag name already exists (locally or in ActiveCampaign), it will be retrieved instead of creating a duplicate. No errors, just works! ### From Code [](#from-code) Use the `ActiveCampaign` facade to create or retrieve tags programmatically: #### Recommended: `getOrCreateTag()` (Safe, no duplicates) [](#recommended-getorcreatetag-safe-no-duplicates) ``` use XaviCabot\FilamentActiveCampaign\Facades\ActiveCampaign; // Get existing tag or create if it doesn't exist $tag = ActiveCampaign::getOrCreateTag('VIP Customer'); // With description (only used if creating) $tag = ActiveCampaign::getOrCreateTag('Premium Member', 'Users with premium subscription'); // The returned $tag is an ActiveCampaignTag model instance echo $tag->ac_id; // ActiveCampaign ID echo $tag->name; // Tag name echo $tag->description; // Optional description ``` **What happens with `getOrCreateTag()`:** 1. Searches local database first (case-insensitive) 2. If not found locally, searches ActiveCampaign API 3. If found in AC but not locally, syncs it to local database 4. If not found anywhere, creates it in ActiveCampaign and stores locally 5. Cache automatically updated for instant use **Benefits:** - βœ… No duplicate errors - βœ… Idempotent (safe to call multiple times) - βœ… Handles sync automatically #### Alternative: `createTag()` (Always creates new) [](#alternative-createtag-always-creates-new) ``` // Only use if you're sure the tag doesn't exist $tag = ActiveCampaign::createTag('New Tag', 'Description'); ``` **Warning:** This method will fail if the tag already exists in ActiveCampaign. **Note:** All tags are created with type `contact` (the standard type for 99% of use cases). --- 🧷 Managing Contact Tags & Lookup ------------------------------------ [](#-managing-contact-tags--lookup) Use the `ActiveCampaign` facade to manage tags on a contact and to look up existing contacts. ``` use XaviCabot\FilamentActiveCampaign\Facades\ActiveCampaign; // Find a contact by email (returns null if it does not exist) $contact = ActiveCampaign::getContactByEmail('jane@example.com'); // Attach one tag ActiveCampaign::addTagToContact($contact['id'], 'vip'); // Attach several tags in one call ActiveCampaign::addTagToContact($contact['id'], ['vip', 'beta-tester']); // List the tag associations for a contact $associations = ActiveCampaign::getContactTags($contact['id']); // Detach a tag by name (no-op if it is not attached) ActiveCampaign::removeTagFromContact($contact['id'], 'beta-tester'); ``` Tag names are resolved to ActiveCampaign IDs using the same cached lookup as `addTagToContact` β€” make sure the tag has been synced (`php artisan activecampaign:sync-metadata --tags`) or created beforehand. --- ⚑ Single-Call Field Sync ------------------------ [](#-single-call-field-sync) When an automation has multiple `fields` and/or `system_fields`, the package now sends them in a **single** `POST /contact/sync` request (plus the initial contact resolution call) instead of one HTTP call per field. No code change is required on the consumer side β€” existing automations benefit automatically. > **Behavioural note:** a custom field whose template references `{user.*}` or `{ctx.*}` and resolves to an empty value is now omitted from the payload (it used to be sent as an empty string). This mirrors how `system_fields` already behaved and prevents accidental overwrites with blank values. --- πŸ“¦ Filament Resources Included ----------------------------- [](#-filament-resources-included) ResourcePurpose**Automations**Create automations triggered by custom events**Automation Logs**Inspect execution results, payloads, warnings, errors**Lists**Read-only view of AC lists**Tags**View and create AC tags**Fields**Read-only view of AC custom fields--- ⚑ Creating Automations ---------------------- [](#-creating-automations) An Automation links: - a **custom event name** - to a set of **ActiveCampaign actions** Actions available: - Subscribe to a list - Add tags - Update custom fields - Update system fields Example automation: SettingValueEvent`user.registered`Listβ€œMain List”Tags`Customer`Custom Fields`LANGUAGE = {user.profile.language}`System Fields`firstName = {user.name}`--- 🧠 Triggering Automations from Your Laravel App ---------------------------------------------- [](#-triggering-automations-from-your-laravel-app) Use the facade: ``` use XaviCabot\FilamentActiveCampaign\Facades\ActiveCampaignAutomations; ActiveCampaignAutomations::trigger('user.registered', $user); ``` With context: ``` ActiveCampaignAutomations::trigger('wallet.first_deposit', $user, [ 'amount' => 150, 'currency' => 'EUR', ]); ``` With another model: ``` ActiveCampaignAutomations::trigger('post.published', $user, [ 'post' => $post, ]); ``` ### Trigger without a registered user (by email) [](#trigger-without-a-registered-user-by-email) You can also trigger automations for contacts that are not users in your system by providing an email and optional contact data. The contact will be created/synced in ActiveCampaign if it does not exist. Basic usage: ``` use XaviCabot\FilamentActiveCampaign\Facades\ActiveCampaignAutomations; ActiveCampaignAutomations::triggerWithEmail('newsletter.signup', 'john@example.com'); ``` With optional contact data and context: ``` ActiveCampaignAutomations::triggerWithEmail( 'lead.captured', 'jane@example.com', [ 'firstName' => 'Jane', 'lastName' => 'Doe', 'phone' => '+1 555 123 4567', ], [ 'source' => 'landing-123', 'utm' => [ 'campaign' => 'winter-sale', ], ] ); ``` Notes: - email is required; other contact fields are optional. - System fields defined in the automation will be synced using the provided email. - Template placeholders {ctx.*} work as usual; {user.*} placeholders will be left as-is if no user is provided. --- πŸ”€ Async (Queue) Support ----------------------- [](#-async-queue-support) By default, automations run synchronously. You can enable async execution to dispatch triggers to a Laravel queue. ### Configuration [](#configuration) In your published `config/activecampaign.php`: ``` 'async' => false, // Set to true to dispatch all triggers to queue 'queue' => 'default', // Queue name 'async_tries' => 3, // Max retry attempts 'async_backoff' => [10, 60], // Backoff in seconds between retries ``` Or use environment variables: ``` ACTIVECAMPAIGN_ASYNC=true ACTIVECAMPAIGN_QUEUE=activecampaign ``` ### Usage [](#usage) #### Option 1: Global async via config [](#option-1-global-async-via-config) Set `async => true` in config. All `trigger()` and `triggerWithEmail()` calls will automatically dispatch to the queue: ``` // These will be queued automatically when async is enabled ActiveCampaignAutomations::trigger('user.registered', $user); ActiveCampaignAutomations::triggerWithEmail('newsletter.signup', 'jane@example.com'); ``` #### Option 2: Explicit async methods [](#option-2-explicit-async-methods) Use `triggerAsync()` or `triggerWithEmailAsync()` to always dispatch to the queue, regardless of the `async` config value: ``` // Always queued, even if async config is false ActiveCampaignAutomations::triggerAsync('user.registered', $user, ['plan' => 'pro']); ActiveCampaignAutomations::triggerWithEmailAsync('lead.captured', 'jane@example.com', [ 'firstName' => 'Jane', ], [ 'source' => 'landing-page', ]); ``` ### How it works [](#how-it-works) - The job serializes only primitive data (event name, user ID, email, contact data, context) β€” no Eloquent models are serialized. - When a `userId` is provided, the job resolves the user from the database at execution time. If the user no longer exists, the job exits gracefully without errors. - Retries and backoff are configurable via `async_tries` and `async_backoff`. ### Retrocompatibility [](#retrocompatibility) With `async => false` (default), the package behaves exactly as before β€” all triggers execute synchronously. No changes needed in existing code. --- 🧩 Template Engine ----------------- [](#-template-engine) Templates support: ### Global [](#global) - `{now}` β€” current datetime - `{now_date}` β€” current date ### User data (supports relations) [](#user-data-supports-relations) ``` {user.email} {user.name} {user.profile.phone} {user.profile.language.name} ``` ### Context data [](#context-data) ``` {ctx.amount} {ctx.currency} {ctx.post.title} {ctx.invoice.total} ``` If a value is missing β†’ placeholder is preserved. Objects/arrays β†’ JSON encoded. --- πŸ” Preview Mode (For Testing Automations) ---------------------------------------- [](#-preview-mode-for-testing-automations) From Filament, you can **preview** an automation: - Select a User - Provide JSON context - Preview the execution plan **without** hitting ActiveCampaign - See: - list subscription - tags - field updates - system fields - rendered templates - warnings - payload Perfect for debugging before going live. --- πŸ“ Execution Logs ---------------- [](#-execution-logs) Every execution is stored in: ``` activecampaign_automation_logs ``` Includes: - automation\_id - event - user\_id - success - error\_message - context (JSON) - payload (JSON) - warnings (missing tags/fields/etc.) Filament UI offers: - warning icons - JSON pretty blocks - full detail view --- πŸš€ Examples β€” Automation on User Registration -------------------------------------------- [](#-examples--automation-on-user-registration) ### 1. Create automation in Filament: [](#1-create-automation-in-filament) - Event: `user.registered` - List: β€œMain List” - Tags: β€œNew User” - Custom fields: - `LANGUAGE = {user.profile.language}` - System fields: - `firstName = {user.name}` ### 2. Trigger from your application: [](#2-trigger-from-your-application) ``` use XaviCabot\FilamentActiveCampaign\Facades\ActiveCampaignAutomations; public function register(Request $request) { $user = User::create([...]); ActiveCampaignAutomations::trigger('user.registered', $user); return $user; } ``` --- ❀️ Contributing --------------- [](#️-contributing) PRs are welcome, especially for: - new actions - templates - automation presets - improvements to the runner or logging --- πŸ“„ License --------- [](#-license) MIT License. ### Health Score 45 β€” FairBetter than 91% of packages Maintenance90 Actively maintained with recent releases Popularity16 Limited adoption so far Community6 Small or concentrated contributor base Maturity56 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits β€” single point of failure How is this calculated?**Maintenance (25%)** β€” Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** β€” Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** β€” Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** β€” Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~10 days Recently: every ~18 days Total 17 Last Release 47d ago Major Versions v0.1.5 β†’ v1.0.02026-01-31 v1.2.0 β†’ v2.0.02026-03-06 v1.3.0 β†’ v2.1.02026-05-19 ### Community Maintainers ![](https://www.gravatar.com/avatar/c306544de15f8dabd17b623e794ab75e5905b7d89c2a4b56e7fec629d2a02347?d=identicon)[xavicabot](/maintainers/xavicabot) --- Top Contributors [![xavicabot](https://avatars.githubusercontent.com/u/25738574?v=4)](https://github.com/xavicabot "xavicabot (23 commits)") ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/xavicabot-filament-activecampaign/health.svg) ``` [![Health](https://phpackages.com/badges/xavicabot-filament-activecampaign/health.svg)](https://phpackages.com/packages/xavicabot-filament-activecampaign) ``` ### Alternatives [defstudio/telegraph A laravel facade to interact with Telegram Bots 816334.1k3](/packages/defstudio-telegraph)[althinect/filament-spatie-roles-permissions 3481.1M10](/packages/althinect-filament-spatie-roles-permissions) PHPackages Β© 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)