ActivitySmith PHP SDK

The ActivitySmith PHP SDK provides convenient access to the ActivitySmith API from PHP applications.

Documentation

See API reference.

Installation

composer require activitysmith/activitysmith

Setup

<?php

declare(strict_types=1);

use ActivitySmith\ActivitySmith;

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

Usage

Send a Push Notification

$response = $activitysmith->notifications->send([
    'title' => 'Build Failed',
    'message' => 'CI pipeline failed on main branch',
]);

echo $response->getSuccess() ? 'true' : 'false';
echo PHP_EOL;
echo $response->getDevicesNotified();

Start a Live Activity

$start = $activitysmith->liveActivities->start([
    'content_state' => [
        'title' => 'ActivitySmith API Deployment',
        'subtitle' => 'start',
        'number_of_steps' => 4,
        'current_step' => 1,
        'type' => 'segmented_progress',
        'color' => 'yellow',
    ],
]);

$activityId = $start->getActivityId();

Update a Live Activity

$update = $activitysmith->liveActivities->update([
    'activity_id' => $activityId,
    'content_state' => [
        'title' => 'ActivitySmith API Deployment',
        'subtitle' => 'npm i & pm2',
        'current_step' => 3,
    ],
]);

echo $update->getDevicesNotified();

End a Live Activity

$end = $activitysmith->liveActivities->end([
    'activity_id' => $activityId,
    'content_state' => [
        'title' => 'ActivitySmith API Deployment',
        'subtitle' => 'done',
        'current_step' => 4,
        'auto_dismiss_minutes' => 3,
    ],
]);

echo $end->getSuccess() ? 'true' : 'false';

Error Handling

try {
    $activitysmith->notifications->send([
        'title' => 'Build Failed',
    ]);
} catch (Throwable $err) {
    echo 'Request failed: ' . $err->getMessage() . PHP_EOL;
}

API Surface

• $activitysmith->notifications
• $activitysmith->liveActivities

Requirements

• PHP 8.1+

License

MIT