Introducing LiveActivityRead more

← All posts
Guide

Scheduling Live Activities with startAt

Start a Live Activity at a set time, on-device on iOS 26 and by push-to-start everywhere else.

A food order that goes live when the kitchen starts cooking, a match that appears at kick-off, a boarding pass that shows up an hour before departure. All of them start a Live Activity at a known time, often while the app isn’t running.

One field

Pass startAt (milliseconds since the epoch) when you create the activity:

{
  "appId": "<app id>",
  "userId": "user_42",
  "attributesType": "DeliveryAttributes",
  "attributes": { "orderId": "1234" },
  "contentState": { "eta": 15, "status": "cooking" },
  "startAt": 1795180000000
}

Leave it out to start right away.

Two paths to the Lock Screen

  • iOS 17.2 and later: at startAt we send a push-to-start to every device of userId, using the push-to-start token the SDK reported.
  • iOS 26: call LiveActivity.schedule(…) in the app and the system schedules the activity on the device itself. We wait 60 seconds after startAt; if the device hasn’t reported the activity by then, we push it anyway.

So devices on iOS 26 start on time even offline, and every other device still gets it by push.

Changing your mind

DELETE /api/v1/activities/<id> cancels an activity before it starts. After it starts, PATCH updates it and /end ends it. Every step is in the activity’s timeline and goes out as a webhook.

Keep reading

Ready to ship Live Activities?

# start one from your backend
curl -X POST https://liveactivity.dev/api/v1/activities \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "appId": "app_...",
    "userId": "user_42",
    "attributesType": "DeliveryAttributes",
    "attributes": { "orderId": "1234" },
    "contentState": { "eta": 15, "status": "cooking" }
  }'

→ on the Lock Screen