PHPackages glue-agency/craft-influx - 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. glue-agency/craft-influx ActiveCraft-plugin[API Development](/categories/api) glue-agency/craft-influx ======================== Connects Craft elements to external JSON APIs. Links are stored in Project Config. 1.0.0-alpha.10(2w ago)073↓22.2%mitPHPPHP >=8.1 Since Jul 3Pushed 1mo agoCompare [ Source](https://github.com/glue-agency/craft-influx)[ Packagist](https://packagist.org/packages/glue-agency/craft-influx)[ RSS](/packages/glue-agency-craft-influx/feed)WikiDiscussions master Synced 1w ago READMEChangelogDependencies (10)Versions (11)Used By (0) Influx ====== [](#influx) Connect Craft elements to external JSON APIs. A lighter, Project-Config-backed alternative to FeedMe that **hydrates existing element types** (Entries, Calendar Events, Commerce Products, …) instead of owning its own element type. Why another sync plugin ----------------------- [](#why-another-sync-plugin) FeedMe carries a lot of historical surface area (XML, CSV, complex UIs, project-config quirks). Influx makes a few opinionated cuts: - **Project Config is the source of truth.** Links live under `influx.links.{uid}` and round-trip to YAML the same way sections, entry types, and volumes do — full diff, full deploy story, full `allowAdminChanges` gating. - **JSON only.** One transport, one parser. - **Hydrates, doesn't own.** Influx writes to whatever element type you point it at. Hooking it to Solspace Calendar's `Event` is a target adapter, not a fork. - **Change-detection before save.** Each mapping reports whether it would change anything; unchanged elements skip the save entirely. - **`.env`-backed auth headers** resolved at fetch-time. - **Per-language endpoints in a single link.** One link can fan out across Craft sites and write localized values onto the same canonical element. Requirements ------------ [](#requirements) - Craft CMS 4.0+ or 5.0+ - PHP 8.1+ Installation ------------ [](#installation) ``` composer require glue-agency/craft-influx ./craft plugin/install influx ``` Quick start ----------- [](#quick-start) 1. Open `Influx → Links` in the CP and click **New link** (requires `allowAdminChanges`). 2. Fill in the form. The shape mirrors Craft's own Sections / Entry Types editors. 3. Save. The link is written to Project Config; commit the resulting YAML in `config/project/`. 4. Trigger a sync from the link page, the entry edit page, or the CLI: ``` ./craft influx/sync news # one link by handle ./craft influx/sync --all # everything ./craft influx/sync news --ago=hour # use a named "ago" preset ``` ### Migrating from Feed Me [](#migrating-from-feed-me) Existing [Feed Me](https://github.com/craftcms/feed-me) feeds can be converted to Influx links. The command reads the `feedme_feeds` table directly, so Feed Me doesn't need to be enabled — just installed at some point: ``` ./craft influx/feed-me # list available feeds ./craft influx/feed-me 1,3 # import specific feeds ./craft influx/feed-me --all # import everything ./craft influx/feed-me 1 --dry-run # preview the link config without saving ./craft influx/feed-me 1 --force # save even when the link doesn't validate ``` The conversion is best-effort: everything that can't be carried over (Matrix block mappings, parent entries, non-JSON feed types, ...) is reported as a warning so you can finish the link in the builder. Feeds saved by Feed Me 4, 5 and 6 all convert — the stored shape is identical across those majors except for a few renamed handles (e.g. `authorId` → `authorIds`), which the importer accepts interchangeably since rows of different vintages coexist after upgrades. Concepts -------- [](#concepts) ### Targets [](#targets) A `target` is an adapter for one element type. The plugin ships `EntryTarget` (for `craft\elements\Entry`). Third-party plugins register their own: ``` use GlueAgency\Influx\services\TargetsService; Event::on( TargetsService::class, TargetsService::EVENT_REGISTER_TARGETS, fn($event) => $event->types[] = MyCalendarTarget::class, ); ``` A target implements `ElementTargetInterface`: find existing element by match value, build a fresh one (with all the type-specific required attributes set), and handle disable/delete/delete-for-site. ### Mappings [](#mappings) A `mapping` reads one field worth of data off a remote item and applies it to the element. Each mapping declares whether its incoming value would change the element — that's how Influx decides to skip the save when nothing's different. Built-in: `PlainText`. Add more by implementing `MappingInterface` and registering via `MappingService::EVENT_REGISTER_MAPPINGS`. ### Match [](#match) Every link needs a match config: `attribute` is the field/handle on the element used as a stable key (typically a custom plain-text field called `importId`), `source` is the path into the JSON item that provides the value. Influx looks up the existing element by this attribute across all sites — that's how multi-language links land on the same canonical entry. ### Multi-site [](#multi-site) Set per-site endpoints and the link runs once per site. The element is matched once across all sites, so each site's data lands on the right localized row of the same element. ### Events [](#events) Hook into any stage: - `LinksService::EVENT_BEFORE_SAVE_LINK` / `EVENT_AFTER_SAVE_LINK` - `LinksService::EVENT_BEFORE_DELETE_LINK` / `EVENT_AFTER_DELETE_LINK` - `SynchronizationService::EVENT_BEFORE_SYNC_LINK` / `EVENT_AFTER_SYNC_LINK` - `SynchronizationService::EVENT_BEFORE_ITEM` — set `$event->skip = true` or swap `$event->element` to redirect - `SynchronizationService::EVENT_AFTER_ITEM_MAPPING` — mappings have been applied but the element hasn't been saved - `SynchronizationService::EVENT_AFTER_ITEM` — `$event->action` is `created` / `updated` / `unchanged` / `skipped` / `error` - `SynchronizationService::EVENT_REGISTER_ENDPOINT_TOKENS` — mutate `$event->tokens` to add / override / remove tokens substituted into the link's Resource Endpoint URL - `SynchronizationService::EVENT_REGISTER_ENDPOINT_TOKEN_SUGGESTIONS` — append entries to `$event->suggestions` so plugin-contributed tokens show up in the edit-screen "Append token" picker - `TargetsService::EVENT_REGISTER_TARGETS` - `MappingService::EVENT_REGISTER_MAPPINGS` ### Integrations [](#integrations) Code that exists to play nice with *other* plugins lives under `src/integrations/`, one sub-namespace per plugin: - `integrations/feedme` — converts [Feed Me](https://github.com/craftcms/feed-me) feeds into Influx links (see [Migrating from Feed Me](#migrating-from-feed-me)). - `integrations/calendar` *(planned)* — an `EventTarget` for Solspace Calendar's Event element type, registered when the plugin is installed. Anything in there treats the other plugin as optional: integrations read its tables or registered services defensively and never make Influx depend on it being installed. Design decisions ---------------- [](#design-decisions) - **Project Config, not custom YAML.** Earlier drafts wrote feed YAML to `config/influx/`. That worked but reinvented the wheel — Craft's Project Config already does YAML round-tripping, `allowAdminChanges` gating, change tracking, and deploy ergonomics. Influx uses it. - **One link = one canonical element across all sites.** Multi-site links share the same match value across per-site endpoints; per-site Craft rows on that element receive site-localized data. - **Change detection is mapping-driven.** Each mapping implements `hasChanged()` because a single `==` against the element value gives false-positives on relations, dates, matrix/super-table. Roadmap ------- [](#roadmap) - Delete/disable/delete-for-site reconciliation for items that have left the remote feed. - Queue-job-based runs and batching (`batchSize` is honoured by config but the engine currently runs inline). - Mappings beyond `PlainText`: Number, Lightswitch, Date, Entries (relations), Categories, Tags, Assets, Matrix, SuperTable. - Webhook entry point for push-style links. - Solspace Calendar target adapter. Acknowledgements ---------------- [](#acknowledgements) Influx is heavily inspired by [Feed Me](https://github.com/craftcms/feed-me) (`craftcms/feed-me`). Its mapping model — per-field-type strategies, relation sub-fields, asset upload-on-import, and change detection before save — follows trails Feed Me blazed. Influx makes different trade-offs (JSON-only, Project Config-backed, hydrating existing element types rather than owning its own), but it stands on Feed Me's shoulders, and the `integrations/feedme` converter exists so you can bring your existing feeds along. License ------- [](#license) MIT. ### Health Score 38 — LowBetter than 83% of packages Maintenance93 Actively maintained with recent releases Popularity12 Limited adoption so far Community6 Small or concentrated contributor base Maturity35 Early-stage or recently created project 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 ~3 days Total 10 Last Release 15d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/ac8861675294cbb545e7e144ed3b2e2936d1ae156236295082dcc1d837d499e2?d=identicon)[glue-agency](/maintainers/glue-agency) --- Top Contributors [![ThomasDeMarez](https://avatars.githubusercontent.com/u/10974106?v=4)](https://github.com/ThomasDeMarez "ThomasDeMarez (83 commits)") ### Code Quality TestsCodeception ### Embed Badge ![Health badge](/badges/glue-agency-craft-influx/health.svg) ``` [![Health](https://phpackages.com/badges/glue-agency-craft-influx/health.svg)](https://phpackages.com/packages/glue-agency-craft-influx) ``` ### Alternatives [craftcms/feed-me Import content from XML, RSS, CSV or JSON feeds into entries, categories, Craft Commerce products, and more. 292960.7k38](/packages/craftcms-feed-me)[verbb/icon-picker A slick field to pick icons from. Supports SVGs, Sprites, Webfonts, Font Awesome and more. 16172.7k7](/packages/verbb-icon-picker)[spicyweb/craft-neo A Matrix-like field type with block hierarchy 393818.3k12](/packages/spicyweb-craft-neo)[verbb/formie The most user-friendly forms plugin for Craft. 101400.6k79](/packages/verbb-formie)[verbb/feed-me Import content from XML, RSS, CSV or JSON feeds into entries, categories, Craft Commerce products, and more. 29246.5k](/packages/verbb-feed-me)[solspace/craft-freeform The most flexible and user-friendly form building plugin! 54686.7k25](/packages/solspace-craft-freeform) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)