Send push notifications and trigger live activities with PHP

Use the official PHP SDK to deliver immediate push notifications and live activity progress updates for long-running jobs and automation workflows.

Install

composer require activitysmith/activitysmith

Setup

<?php

declare(strict_types=1);

use ActivitySmith\ActivitySmith;

$activitysmith = new ActivitySmith($_ENV['ACTIVITYSMITH_API_KEY']);

PHP SDK

Push Notifications

Send an immediate notification for a completed task or event:

$activitysmith->notifications->send([
    "title" => "New subscription 💸",
    "message" => "Customer upgraded to Pro plan",
]);

PHP SDK

Live Activities

Live Activities come in two UI types, but the lifecycle stays the same: start the activity, keep the returned activityId, update it as state changes, then end it when the work is done.

segmented_progress: best for jobs tracked in steps
progress: best for jobs tracked as a percentage or numeric range

Shared flow

Call $activitysmith->liveActivities->start(...).
Save the returned activityId.
Call $activitysmith->liveActivities->update(...) as progress changes.
Call $activitysmith->liveActivities->end(...) when the work is finished.

Segmented Progress Type

Use segmented_progress when progress is easier to follow as steps instead of a raw percentage. It fits jobs like backups, deployments, ETL pipelines, and checklists where "step 2 of 3" is more useful than "67%". number_of_steps is dynamic, so you can increase or decrease it later if the workflow changes.

Start

$start = $activitysmith->liveActivities->start([
    'content_state' => [
        'title' => 'Nightly database backup',
        'subtitle' => 'create snapshot',
        'number_of_steps' => 3,
        'current_step' => 1,
        'type' => 'segmented_progress',
        'color' => 'yellow',
    ],
    'channels' => ['devs', 'ops'], // Optional
]);

$activityId = $start->getActivityId();

PHP SDK

Update

$update = $activitysmith->liveActivities->update([
    'activity_id' => $activityId,
    'content_state' => [
        'title' => 'Nightly database backup',
        'subtitle' => 'upload archive',
        'current_step' => 2,
    ],
]);

PHP SDK

End

$end = $activitysmith->liveActivities->end([
    'activity_id' => $activityId,
    'content_state' => [
        'title' => 'Nightly database backup',
        'subtitle' => 'verify restore',
        'current_step' => 3,
        'auto_dismiss_minutes' => 2,
    ],
]);

PHP SDK

Progress Type

Use progress when the state is naturally continuous. It fits charging, downloads, sync jobs, uploads, timers, and any flow where a percentage or numeric range is the clearest signal.

Start

$start = $activitysmith->liveActivities->start([
    'content_state' => [
        'title' => 'EV Charging',
        'subtitle' => 'Added 30 mi range',
        'type' => 'progress',
        'percentage' => 15,
        'color' => 'lime',
    ],
]);

$activityId = $start->getActivityId();

PHP SDK

Update

$activitysmith->liveActivities->update([
    'activity_id' => $activityId,
    'content_state' => [
        'title' => 'EV Charging',
        'subtitle' => 'Added 120 mi range',
        'percentage' => 60,
    ],
]);

PHP SDK

End

$activitysmith->liveActivities->end([
    'activity_id' => $activityId,
    'content_state' => [
        'title' => 'EV Charging',
        'subtitle' => 'Added 200 mi range',
        'percentage' => 100,
        'auto_dismiss_minutes' => 2,
    ],
]);