Quickstart

Documentation Index

Fetch the complete documentation index at: https://activitysmith.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

​

Welcome to ActivitySmith

• API: Documentation
• SDKs: Node, Python, Go, PHP, Ruby, CLI
• Others: Zapier

​

Prerequisites

• Create an API key
• Download our iOS app and pair your device(s)

​

Features

• Push Notifications: send push notifications to all paired devices or target specific channels.
• Live Activities: start, update and end a Live Activity on your lock screen or dynamic island, with optional channel targeting and one optional action button.
• Widgets: display any value on your Lock Screen with widgets - SaaS metrics, revenue, signups, uptime, habits, or anything else you want to track.
• Inbound Webhooks: forward events from external services such as Vercel, Netlify, Railway, and more, into Push Notifications and Live Activities.

​

Powerful Capabilities

• Glanceable observability: monitor real-time system state and long-running operations directly on your lock screen or dynamic island.
• The hard stuff: APNs(Apple Push Notification service), certificates, orchestration
• Customizability: adapt the experience to fit your unique needs.
• Works with any backend: use with any backend, cron, agent, automation or AI tool.
• iOS app: ready to use native iOS app for your iPhone or iPad. No need to build your own.

​

Push Notifications

• media attaches an image, audio file, or video that users can preview or play when they expand the notification.
• redirection opens on normal tap.
• actions (up to 4) appear when users expand the notification.
• media + redirection is supported.
• media + actions is not supported in v1.

curl -X POST https://activitysmith.com/api/push-notification \
  -H "Authorization: Bearer $ACTIVITYSMITH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "New subscription 💸",
    "message": "Customer upgraded to Pro plan"
  }'

{
  "success": true,
  "devices_notified": 3,
  "users_notified": 1,
  "timestamp": "2025-08-12T12:00:00.000Z"
}

​

Live Activities

​

Start & Update Live Activity

• PUT /live-activity/stream/:stream_key
• DELETE /live-activity/stream/:stream_key

​

Action Button

• open_url: opens the provided HTTPS URL in the browser.
• webhook: ActivitySmith’s backend calls your HTTPS webhook with GET or POST.

​

open_url

{
  "content_state": {
    "title": "Deploying payments-api",
    "subtitle": "Running database migrations",
    "number_of_steps": 5,
    "current_step": 3,
    "type": "segmented_progress"
  },
  "action": {
    "title": "Open Workflow",
    "type": "open_url",
    "url": "https://github.com/acme/payments-api/actions/runs/1234567890"
  }
}

​

webhook

{
  "content_state": {
    "title": "Reindexing product search",
    "subtitle": "Shard 7 of 12",
    "number_of_steps": 12,
    "current_step": 7,
    "type": "segmented_progress"
  },
  "action": {
    "title": "Pause Reindex",
    "type": "webhook",
    "url": "https://ops.example.com/hooks/search/reindex/pause",
    "method": "POST",
    "body": {
      "job_id": "reindex-2026-03-19",
      "requested_by": "activitysmith"
    }
  }
}

• Only HTTPS URLs are supported for both action types.
• One button per Live Activity.
• Pass action on an update call to set or replace the button on an active Live Activity.

​

Channel Targeting

{
  "target": {
    "channels": ["devs", "ops"]
  }
}

• If target is omitted and API key scope is all: send to all account recipients.
• If target is omitted and API key scope is channels: send to channels assigned to that key.
• If target.channels is present: only those channel slugs are used.