Download the PHP package tomatophp/filament-workflows without Composer

Filament Workflows Builder

Build automation workflows from your Filament panel. A workflow is made of triggers: a model being created, updated or deleted, an application event being dispatched, or a webhook being called. Each trigger runs the actions you attach to it (PHP classes you register), and every run is written to the workflow logs.

Screenshots

Features

• Workflows, Triggers, Actions and Workflow Logs resources
• A visual builder page per workflow: create / attach triggers, create / attach actions, configure each action
• Model triggers (created / updated / deleted), optionally for a single record
• Event triggers for any event class you register
• Webhook triggers through a token protected endpoint
• An optional where <field> <is> <value> condition on every trigger
• A log row for every executed, failed or skipped action

Compatibility

Installation

After installing the package run the install command (it runs the migrations):

Finally register the plugin in /app/Providers/Filament/AdminPanelProvider.php:

Usage

Everything is registered from a service provider, for example in AppServiceProvider::boot().

Register models

Add the InteractsWithWorkflow trait to every model that can trigger a workflow:

The trait fires the model triggers on created, updated and deleted. It also adds the model to the trigger "Model" list, but only once the model class has been used in the request, so register it explicitly as well to always see it in the builder:

Register events

Any event class can be used as a trigger. Registered events are listened to automatically; the event public properties are the trigger payload (used by the where condition and stored in the log):

Create actions

An action is a class that extends TomatoPHP\FilamentWorkflows\Services\Abstracts\Action. run() receives the event that fired the trigger and the TriggerHasAction row, whose payload holds the settings filled in the form() fields on the builder page. Return an empty array from form() when the action has no settings.

Register it so it shows up in the action "Runs" list:

The event passed to run() is Events\Models\ModelCreated, ModelUpdated or ModelDeleted for model triggers ($event->data is the model, $event->trigger the trigger), Events\Webhook\WebhookEvent for webhooks ($event->data is the request input) and your own event object for event triggers.

Actions run synchronously while the trigger fires. Dispatch a queued job from run() for slow work. Only classes extending Services\Abstracts\Action are executed, and an exception thrown by an action is reported and logged without stopping the other actions.

Build a workflow

1. Create a workflow and switch it to Active (inactive workflows never run).
2. Click Build on the workflow row.
3. Create Trigger (or attach an existing one), choose the type and, optionally, a where / is / value condition (for example status = paid).
4. On the trigger, Create Action (or attach an existing one) and pick the class it runs. Use the gear button to fill the action settings.

Every run shows up in the Workflow Logs resource and under the workflow on the builder page.

Webhooks

Set a token in your .env. While it is empty the webhook endpoint answers 403 to every request:

Then call GET or POST /workflows/webhook (route name workflows.webhook) with the token as the token parameter or the X-Workflow-Token header. A webhook trigger runs when the request input contains the key saved in the trigger "Webhook key" field:

The token is compared in constant time, removed from the payload before it is logged, and the route is throttled to 60 requests per minute. The endpoint does not use the web middleware group, so no session or CSRF token is needed.

Publish Assets

You can publish the config file with:

You can publish the views with:

You can publish the language files with:

You can publish the migrations with:

Testing

Changelog

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

Security

Please see SECURITY for more information about security.

Credits

• Fady Mondy

License

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