Skip to main content

​
Activity Events

Activities are individual units of work within a workflow. Durable Workflow dispatches events when activities start, complete, or fail, allowing you to monitor and react to activity execution.

​
ActivityStarted

Dispatched when an activity begins execution within a workflow.

​
Properties

PropertyTypeDescription
workflowIdint|stringUnique identifier for the parent workflow instance
activityIdstringUnique identifier for this activity execution
classstringFully qualified class name of the activity
indexintSequential index of this activity in the workflow
argumentsstringSerialized activity input arguments
timestampstringISO 8601 timestamp when the activity started

​
Example Usage

use Workflow\Events\ActivityStarted;
use Illuminate\Support\Facades\Event;

Event::listen(ActivityStarted::class, function (ActivityStarted $event) {
    logger()->info('Activity started', [
        'workflow_id' => $event->workflowId,
        'activity_id' => $event->activityId,
        'activity_class' => $event->class,
        'index' => $event->index,
        'started_at' => $event->timestamp,
    ]);
});

​
Listening in EventServiceProvider

protected $listen = [
    \Workflow\Events\ActivityStarted::class => [
        \App\Listeners\LogActivityStarted::class,
        \App\Listeners\TrackActivityMetrics::class,
    ],
];

​
ActivityCompleted

Dispatched when an activity successfully completes execution.

​
Properties

PropertyTypeDescription
workflowIdint|stringUnique identifier for the parent workflow instance
activityIdstringUnique identifier for this activity execution
outputstringSerialized activity output/result
timestampstringISO 8601 timestamp when the activity completed
classstringFully qualified class name of the activity
indexintSequential index of this activity in the workflow

​
Example Usage

use Workflow\Events\ActivityCompleted;
use Illuminate\Support\Facades\Event;

Event::listen(ActivityCompleted::class, function (ActivityCompleted $event) {
    logger()->info('Activity completed', [
        'workflow_id' => $event->workflowId,
        'activity_id' => $event->activityId,
        'activity_class' => $event->class,
        'output' => $event->output,
        'completed_at' => $event->timestamp,
    ]);
    
    // Calculate activity duration
    $startTime = cache()->get("activity.{$event->activityId}.start_time");
    if ($startTime) {
        $duration = strtotime($event->timestamp) - $startTime;
        metrics()->timing('activity.duration', $duration, [
            'class' => $event->class,
        ]);
    }
});

​
Listening in EventServiceProvider

protected $listen = [
    \Workflow\Events\ActivityCompleted::class => [
        \App\Listeners\LogActivityCompleted::class,
        \App\Listeners\RecordActivityMetrics::class,
    ],
];

​
ActivityFailed

Dispatched when an activity fails due to an exception or error.

​
Properties

PropertyTypeDescription
workflowIdint|stringUnique identifier for the parent workflow instance
activityIdstringUnique identifier for this activity execution
outputstringSerialized error information or exception details
timestampstringISO 8601 timestamp when the activity failed
classstringFully qualified class name of the activity
indexintSequential index of this activity in the workflow

​
Example Usage

use Workflow\Events\ActivityFailed;
use Illuminate\Support\Facades\Event;

Event::listen(ActivityFailed::class, function (ActivityFailed $event) {
    logger()->error('Activity failed', [
        'workflow_id' => $event->workflowId,
        'activity_id' => $event->activityId,
        'activity_class' => $event->class,
        'error' => $event->output,
        'failed_at' => $event->timestamp,
    ]);
    
    // Track failure metrics
    metrics()->increment('activity.failed', 1, [
        'class' => $event->class,
    ]);
    
    // Alert if critical activity fails
    if (str_contains($event->class, 'CriticalActivity')) {
        Alert::send(new ActivityFailureAlert($event));
    }
});

​
Listening in EventServiceProvider

protected $listen = [
    \Workflow\Events\ActivityFailed::class => [
        \App\Listeners\LogActivityFailure::class,
        \App\Listeners\AlertOnActivityFailure::class,
    ],
];

​
Activity Lifecycle Tracking

You can track the complete lifecycle of an activity by listening to all three events: 
namespace App\Listeners;

use Workflow\Events\ActivityStarted;
use Workflow\Events\ActivityCompleted;
use Workflow\Events\ActivityFailed;

class ActivityLifecycleTracker
{
    public function handleStarted(ActivityStarted $event): void
    {
        cache()->put(
            "activity.{$event->activityId}.start_time",
            strtotime($event->timestamp),
            now()->addHour()
        );
    }
    
    public function handleCompleted(ActivityCompleted $event): void
    {
        $startTime = cache()->get("activity.{$event->activityId}.start_time");
        $duration = $startTime ? strtotime($event->timestamp) - $startTime : null;
        
        logger()->info('Activity lifecycle completed', [
            'activity_id' => $event->activityId,
            'duration_seconds' => $duration,
        ]);
        
        cache()->forget("activity.{$event->activityId}.start_time");
    }
    
    public function handleFailed(ActivityFailed $event): void
    {
        $startTime = cache()->get("activity.{$event->activityId}.start_time");
        $duration = $startTime ? strtotime($event->timestamp) - $startTime : null;
        
        logger()->error('Activity lifecycle failed', [
            'activity_id' => $event->activityId,
            'duration_seconds' => $duration,
            'error' => $event->output,
        ]);
        
        cache()->forget("activity.{$event->activityId}.start_time");
    }
    
    public function subscribe($events): array
    {
        return [
            ActivityStarted::class => 'handleStarted',
            ActivityCompleted::class => 'handleCompleted',
            ActivityFailed::class => 'handleFailed',
        ];
    }
}
Register the subscriber in EventServiceProvider: 
protected $subscribe = [
    \App\Listeners\ActivityLifecycleTracker::class,
];

​
Filtering Activities by Workflow

You can filter activity events by their parent workflow: 
use Workflow\Events\ActivityCompleted;
use Illuminate\Support\Facades\Event;

Event::listen(ActivityCompleted::class, function (ActivityCompleted $event) {
    // Only handle activities from specific workflows
    $workflow = Workflow::find($event->workflowId);
    
    if ($workflow && $workflow->class === \App\Workflows\OrderProcessing::class) {
        // Handle order processing activity completion
        ProcessOrderActivity::dispatch($event->activityId);
    }
});

​
Global Activity Event Listening

You can listen to all activity events using a wildcard listener: 
use Illuminate\Support\Facades\Event;

Event::listen('Workflow\\Events\\Activity*', function (string $eventName, array $data) {
    logger()->debug('Activity event fired', [
        'event' => $eventName,
        'data' => $data,
    ]);
});

Build docs developers (and LLMs) love

Get started for freeTalk to us