@fayz-ai/plugin-automations
v0.13.3
Published
[experimental] Fayz SDK — workflows & automations plugin
Downloads
1,420
Readme
@fayz-ai/plugin-automations
Status: experimental (incubating). Not capability-complete — missing some or all of the capability bar (data-provider contract w/ supabase+mock pair, entity registries, settings, migrations; see
docs/plugins/PLUGIN-PATTERNS.md). Fine to explore in dogfoods; NOT ready for fresh installs or generated apps, and its API may change without notice.
Visual trigger → action workflows, native to your app's own events.
The best automations don't live in a third-party tool watching webhooks from the outside — they live inside the app, listening to its own events. plugin-automations is the GoHighLevel "Automation" surface for Fayz: when a form is submitted, a call is missed, or a deal is won, fan out into SMS, email, waits, tags, and tasks. Because it's a plugin in the same defineSaas app, it can react to real domain events instead of guessing from polling.
We're honest about where it is. M1 ships a polished /automations home — real workflow cards with triggers, multi-step sequences, and enrollment stats — to lock the model and UX. The trigger→action execution engine (over the core event bus + scheduler) is the next milestone.
What's inside
/automationsroute + nav entry (iconZap), permission-gated onautomations:read- Automations home view — workflows with triggers, step sequences (SMS, email, wait, tag, task), and enrollment counts
- Universal scope — works across every vertical
- Configurable nav —
navPosition,navSection,navLabel - Declared feature —
automations(in the "Automate" group) for permissions and feature gating
Status: M1 mock home. The execution engine over the event bus + scheduler is on the roadmap.
Install
npm install @fayz-ai/plugin-automationsPeer deps: react, react-dom. Runtime deps: @fayz-ai/core, @fayz-ai/ui.
Usage
import { defineSaas } from '@fayz-ai/admin'
import { createAutomationsPlugin } from '@fayz-ai/plugin-automations'
export const app = defineSaas({
// ...
plugins: [
createAutomationsPlugin({
navLabel: 'Automations',
navPosition: 6,
}),
],
})Part of the Fayz SDK
One of the composable plugins for @fayz-ai/admin — this one owns the automate surface: workflows that react to your app's events.
Roadmap & contributing
Built and evolving in the open. See the Fayz SDK roadmap for current gaps, missing features, and good first issues.
