Introducing LiveActivityRead more

Getting started / IntroductionMenu

Introduction

What LiveActivity does, how the pieces fit, and where to start.

Updated · Markdown · Ask Claude · Ask ChatGPT

LiveActivity is an API for iOS Live Activities. Your backend tells us to start, update or end an activity, and we push it to your users’ phones through Apple’s push service (APNs). You don’t run any push infrastructure and you don’t track ActivityKit tokens yourself.

How the pieces fit

  • The dashboard. You add your iOS app once: bundle ID, Team ID and an APNs key (.p8). You get a publishable key (pk_…) for the app and a webhook signing secret (whsec_…). You also create a secret API key (sk_…) for your backend.
  • The SDK, in your iOS app. It reports every push-to-start token, activity and update token to us with the publishable key. It can only register devices, so it is safe to ship. There is a Swift SDK and an Expo / React Native SDK.
  • The REST API, from your backend. You call POST /api/v1/activities with a user ID and the content state. We find that user’s devices and push. See the API reference.
  • Webhooks, back to your backend. We tell you when an activity started on a phone, got a new token, ended, or when Apple refused a push. See Webhooks.

Where to start