Introducing LiveActivityRead more

Getting started / QuickstartMenu

Quickstart

From sign-up to your first Live Activity on a device.

Updated · Markdown · Ask Claude · Ask ChatGPT

Set it up with your coding agent

Opens the app with the prompt typed in, or the web app if it isn't installed. Nothing runs until you press Enter.

You need an iOS app with a widget extension, an Apple Developer account and a real iPhone. The iOS Simulator does not issue push tokens.

1. Create an account

Sign up with your email or Google. Every account starts with a 14-day trial of Pro, no card needed, and then stays on the Free plan until you pick one.

2. Add your app

In Apps → Add app, enter:

  • the bundle ID of your iOS app,
  • your Team ID and the Key ID of an APNs key (10 letters and digits each),
  • the APNs key itself: the whole .p8 file, created in Apple Developer → Keys (token based),
  • the environment: Sandbox for builds run from Xcode, Production for TestFlight and App Store builds.

An app has one environment. A token from a sandbox build sent to the production server (or the other way round) is refused by Apple, so register a second app if you test both. See Troubleshooting.

You get a publishable key (pk_…) for the SDK and a webhook signing secret (whsec_…).

3. Add the SDK to your app

Run the app once on a device. The app’s page in the dashboard shows the device as ready when it has registered a push-to-start token (iOS 17.2+).

4. Create a secret key

Create an API key in Settings → Organization → API keys. It starts with sk_ and belongs to your backend only.

5. Start your first Live Activity

curl https://liveactivity.dev/api/v1/activities \
  -H "Authorization: Bearer $API_KEY" -H "Content-Type: application/json" \
  -d '{
    "appId": "<app id>",
    "userId": "user_42",
    "attributesType": "DeliveryAttributes",
    "attributes": { "orderId": "1234" },
    "contentState": { "eta": 15, "status": "cooking" },
    "alert": { "title": "Your order", "body": "Cooking now" }
  }'

userId is the ID you passed to identify in the app. The activity appears on the lock screen. Open it under Activities in the dashboard to see every push and what Apple answered.

Next: update and end it, or add webhooks.