ActivitySmith Quickstart Guide

Pair your iOS device, create an API key, and send a Push Notification or Live Activity from Playground or your own code.

6 min readLast updated May 7, 2026

Initial setup

ActivitySmith needs two things before it can deliver anything: a paired iOS device and an API key from the web app. Use the same account in the iOS app and the web app, then finish the missing step below.

I started in the iOS app

Go to Devices in the mobile app and tap Pair This Device. Sign in to the web app with the same email, open API Keys, and create a key.

I started in the web app

Download the iOS app, sign in with the same account, open Devices, and tap Pair This Device so events have somewhere to land.

Send your first event

Use Playground first if you want the fastest visual confirmation. Then use an ActivitySmith SDK or cURL to send the same event from your backend.

Store your API key as ACTIVITYSMITH_API_KEY, then copy the example for your stack into a backend service, script, CI pipeline, cron job, or automation.

API examples

Use the official SDKs for Node, Python, PHP, Ruby, Go, and CLI, or use cURL for a direct API request.

Push Notification

1
import ActivitySmith from "activitysmith";
2
3
const activitysmith = new ActivitySmith({
4
  apiKey: process.env.ACTIVITYSMITH_API_KEY!,
5
});
6
7
await activitysmith.notifications.send({
8
  title: "Cha-ching! 💸",
9
  message: "Trial user upgraded to Pro plan",
10
});

View on GitHub

Node SDK

Learn more about Push Notifications

Live Activity

1
import ActivitySmith from "activitysmith";
2
3
const activitysmith = new ActivitySmith({
4
  apiKey: process.env.ACTIVITYSMITH_API_KEY!,
5
});
6
7
await activitysmith.liveActivities.start({
8
  content_state: {
9
    type: "segmented_progress",
10
    title: "API Deployment",
11
    subtitle: "deploy",
12
    color: "purple",
13
    number_of_steps: 5,
14
    current_step: 1,
15
  },
16
});