Events

All events are final readonly, dispatched after commit and never broadcast. Instance, step and escalation events carry the instance as $actor and the Actor DTO as $runAs:

Event	Payload
`InstanceStarted`	instance
`StepStarted`	instance, stepRun
`StepCompleted`	instance, stepRun, outcome
`StepFailed`	instance, stepRun, code, willRetry
`InstanceWaiting`	instance, stepRun, waits
`InstanceResumed`	instance, stepRun, signal (SignalKind)
`InstanceCompleted`	instance
`InstanceFailed`	instance, code, message, node
`InstanceCancelled`	instance, reason
`InstanceRetried`	instance, stepRun
`EscalationTriggered`	instance, stepRun, level, actions
`EscalationFailed`	instance, stepRun, level, code
`VersionPublished`	definition, version, publisher
`DraftSaved`	definition, version
`DefinitionRetired`	definition

use RoundlyConsulting\Workflows\Events\InstanceFailed;

Event::listen(InstanceFailed::class, function (InstanceFailed $event): void {
    Log::warning('Workflow failed', [
        'instance' => $event->instance->ulid,
        'code' => $event->code,          // a FailureCode value or a host step's code
        'node' => $event->node,
    ]);
});

Show your open-source love

This package is free and MIT-licensed. If it saves you time, a one-off donation or a Patreon membership keeps it maintained, tested and documented.

More ways to support, including crypto

By donating, you agree to our donation terms.

Support our open source work Join us on Patreon

Want this built into your product?

We integrate our packages into custom Laravel and AI builds. Tell us what you're working on and we'll reply within 48 hours.

Get a quote in 48 hours Browse all packages