> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.onesignal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Live Activities

> Deliver real-time updates to the iOS Lock Screen and Dynamic Island with OneSignal Live Activities. Use for time-bound events like delivery tracking, sports scores, ride status, and live game updates.

Live Activities deliver real-time updates to the iOS and iPadOS Lock Screen and Dynamic Island, keeping users informed without opening your app. Use them for time-bound events like delivery tracking, sports scores, ride status, and live game updates. Introduced in iOS 16.1 and expanded in iOS 17.

<Note>
  Live Activities are an iOS feature. For similar capability on Android, see [Android Live Notifications](./android-live-notifications).
</Note>

<Frame caption="Live Activities examples">
  <img src="https://mintcdn.com/onesignal/MUgio66t0sYhGEvj/images/docs/67688a22bb44b87b57a4bd27f114eea45298dfa4d1d48f1b64b2d449ea93c206-channel-setup-live-activities.jpg?fit=max&auto=format&n=MUgio66t0sYhGEvj&q=85&s=dde03fd57c37604ed28894c0d49d1480" alt="Examples of iOS Live Activities on the Lock Screen and Dynamic Island showing delivery tracking, sports scores, and ride status" width="1280" height="720" data-path="images/docs/67688a22bb44b87b57a4bd27f114eea45298dfa4d1d48f1b64b2d449ea93c206-channel-setup-live-activities.jpg" />
</Frame>

## When to use Live Activities

Live Activities work best for transactional, time-bound updates with a clear beginning and end. They are visible for up to 8 hours of active updates, do not require push permission for the first activity (they are provisional), and render on premium iOS surfaces like the Lock Screen and Dynamic Island. OneSignal manages the underlying update tokens, scales a single API call across all Subscriptions, and records delivery and engagement analytics for each send.

<Note>
  For use cases and examples, see the [OneSignal Live Activities blog post](https://onesignal.com/blog/new-live-activities-support-to-help-you-drive-loyalty-faster).
</Note>

## Get started

### Requirements

* iOS 16.1+ or iPadOS 17+.
* OneSignal [Mobile SDK](./mobile-sdk-setup) integrated.
* Setup completed per the [Live Activities Developer Setup](./live-activities-developer-setup).
* Click tracking and confirmed receipt require iOS SDK **5.2.15 or higher**.

### How Live Activities work

* **Active updates**: Up to 8 hours from when the activity starts.
* **Stale period**: After the last update or a call to end the activity, iOS keeps the activity visible for up to 4 more hours before removing it automatically.
* **Limit**: Up to 5 simultaneous Live Activities per app.
* **Permissions**: The first activity is provisional — no push permission required. Future activities depend on user settings.
* **Remote start**: Supported on iOS 17.2+ via push-to-start.
* **Content policy**: Must provide user value. Not for ads or purely promotional content.

### Create, update, and end a Live Activity

<Steps>
  <Step title="Start a Live Activity">
    Start an activity in one of two ways:

    1. The [Start Live Activity API](/reference/start-live-activity) (push-to-start).
    2. In-app, by calling ActivityKit from your iOS code. See the [Live Activities Developer Setup](./live-activities-developer-setup).
  </Step>

  <Step title="Update a Live Activity">
    Call the [Update Live Activity API](/reference/update-live-activity-api) with the `activity_id`. OneSignal delivers the update to every Subscription associated with that activity.
  </Step>

  <Step title="End a Live Activity">
    End an activity in one of three ways:

    <Tabs>
      <Tab title="OneSignal SDK (`exitLiveActivity`)">
        * Tells OneSignal to stop sending updates for the given `activityId`.
        * Does **not** remove the activity from the screen. iOS removes it automatically after the 4-hour stale period or when the user dismisses it.
      </Tab>

      <Tab title="Update Live Activity API">
        Call the [Update Live Activity API](/reference/update-live-activity-api) with `event: end` to stop further updates. Include a `dismissal_date` to control when iOS removes the activity from the screen:

        * Omit `dismissal_date` and iOS removes the activity after the 4-hour stale period or when the user dismisses it.
        * Set a **future** `dismissal_date` within the next 4 hours to remove it sooner.
        * Set a **past** `dismissal_date` to remove it immediately. The user must have tapped **Allow** on the first Live Activity for programmatic dismissal to take effect.
      </Tab>

      <Tab title="User action">
        * The user swipes the activity away or otherwise dismisses it.
        * The user revokes Live Activity permission in iOS Settings.
      </Tab>
    </Tabs>
  </Step>
</Steps>

## Analytics and reporting

Track delivery, confirmed receipt, clicks, failures, and unsubscribes on every Live Activity send. Metrics follow the same definitions used across channels — see the [Metrics glossary](./analytics-metrics-glossary) for canonical definitions, and [Live Activities analytics](./live-activities-analytics) for message reports, Audience Activity exports, and rate calculations.

<Card title="Live Activities analytics" icon="chart-mixed" href="./live-activities-analytics">
  Measure delivery, confirmed receipt, clicks, and unsubscribes. Export Audience Activity and compute engagement rates.
</Card>

## Best practices

### Functionality

* Use Live Activities for transactional or contextual updates with a defined beginning and end — for example, ETA, score, or timer.
* Keep each activity shorter than 8 hours of active updates, and only as long as the content remains useful.
* Avoid excessive updates. Frequent updates drain device battery and can trigger throttling.
* Do not use Live Activities for ads or purely promotional content.

### UI and UX

* Support every presentation: Compact, Minimal, Expanded, and Lock Screen.
* Apply your brand, spacing, and dark/light themes consistently.
* Prioritize clarity and tap targets. Do not try to draw attention to the Dynamic Island itself.
* Do not display sensitive information in a Live Activity.

<Note>
  See Apple's [Live Activities Human Interface Guidelines](https://developer.apple.com/design/human-interface-guidelines/live-activities) for more detail.
</Note>

### Targeting at scale

Target users based on the event:

* Use segments for broad events like sports games, concerts, or launches.
* Target individual users for personal or transactional events such as orders and deliveries.

For targeting syntax, see [Create message](/reference/create-message).

### Set update priority

Apple uses the `priority` field on each update to decide how urgent it is. Sending too many high-priority updates in a short window triggers throttling, where iOS delays or drops updates.

* Use a mix of `priority: 5` (standard) and `priority: 10` (high). Reserve `priority: 10` for time-sensitive updates.
* If your use case requires frequent high-priority updates, add `NSSupportsLiveActivitiesFrequentUpdates` to your app's `Info.plist` as a Boolean set to `YES`. See [Apple's guidance on update frequency](https://developer.apple.com/documentation/activitykit/starting-and-updating-live-activities-with-activitykit-push-notifications#Determine-the-update-frequency).
* When the budget is exceeded, iOS may prompt the user to allow additional updates. If the user allows, Apple expands the budget for that app.

For the `priority` field, see the [Update Live Activity API](/reference/update-live-activity-api).

## FAQ

### Do I have access to Live Activities in my plan?

Live Activities are available on all plans except Free plans with more than 10,000 opted-in subscribers. Upgrade from the Free plan to use Live Activities. [See pricing](https://onesignal.com/pricing) or contact `support@onesignal.com`.

### What is the budget for high-priority updates?

Apple does not publish a fixed limit. iOS enforces a dynamic, device-level budget based on recent `priority: 10` usage, and throttles or drops updates when the budget is exceeded. Mix `priority: 5` with `priority: 10`, and reserve high priority for time-sensitive updates. See [Apple's guidance](https://developer.apple.com/documentation/activitykit/starting-and-updating-live-activities-with-activitykit-push-notifications#Determine-the-update-frequency).

### Where can I see Live Activities in the OneSignal dashboard?

Live Activities are sent only through the Live Activity APIs, but you can review historically sent activities in **Sent Messages** filtered to Live Activities for up to 30 days. For aggregate trends, see [Engagement Trends](./engagement-analytics).

### What devices support Live Activities?

Apple maintains the compatibility list for [iOS 16+](https://support.apple.com/guide/iphone/supported-models-iphe3fa5df43/16.0/ios/16.0) and [iPadOS 17+](https://support.apple.com/guide/ipad/ipad-models-compatible-with-ipados-17-ipad213a25b2/ipados).

### What's the difference between Delivered and Confirmed Receipt?

**Delivered** means APNs accepted the Live Activity update for delivery. **Confirmed Receipt** means the OneSignal SDK on the device confirmed that the update actually arrived. Confirmed Receipt requires iOS SDK 5.2.15+ and completed [Confirmed receipt](./confirmed-delivery) setup. See the [Metrics glossary](./analytics-metrics-glossary) for the full definitions.

## Related

<Columns cols={2}>
  <Card title="Live Activities Developer Setup" icon="wrench" href="./live-activities-developer-setup">
    Integrate the OneSignal iOS SDK and configure your app for Live Activities.
  </Card>

  <Card title="Live Activities analytics" icon="chart-mixed" href="./live-activities-analytics">
    Message reports, Audience Activity, and CSV export for Live Activities.
  </Card>

  <Card title="Update Live Activity API" icon="code" href="/reference/update-live-activity-api">
    Send, update, and end Live Activities at scale with the REST API.
  </Card>

  <Card title="Confirmed receipt" icon="circle-check" href="./confirmed-delivery">
    Requirements for device-side receipt confirmation on iOS.
  </Card>

  <Card title="Android Live Notifications" icon="android" href="./android-live-notifications">
    Deliver similar real-time experiences on Android devices.
  </Card>

  <Card title="Metrics glossary" icon="book" href="./analytics-metrics-glossary">
    Canonical definitions for every metric across dashboard, API, CSV, and Event Streams.
  </Card>
</Columns>
