Skip to content

docs(push): add iOS Live Activities page#3464

Merged
ttypic merged 1 commit into
mainfrom
liveactivity-section
Jul 22, 2026
Merged

docs(push): add iOS Live Activities page#3464
ttypic merged 1 commit into
mainfrom
liveactivity-section

Conversation

@ttypic

@ttypic ttypic commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Description

Document starting, updating, and ending iOS Live Activities via Ably-managed APNs broadcast channels: device registration with push-to-start tokens, broadcast channel creation, the start/update/end server calls, and an aps payload and headers reference. Marked Experimental.

Checklist

@ttypic
ttypic requested a review from m-hulbert July 8, 2026 12:55
@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 48a20a6b-2f8f-45de-aa55-f70e16e7355d

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch liveactivity-section

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@ttypic
ttypic requested a review from JoaoDiasAbly July 8, 2026 13:30
@lawrence-forooghian lawrence-forooghian added the review-app Create a Heroku review app label Jul 8, 2026
@ably-ci
ably-ci temporarily deployed to ably-docs-liveactivity--kmqavy July 8, 2026 17:19 Inactive
Comment thread src/pages/docs/push/live-activities.mdx Outdated
Comment thread src/pages/docs/push/live-activities.mdx Outdated
Comment thread src/pages/docs/push/live-activities.mdx Outdated
Comment thread src/pages/docs/push/live-activities.mdx Outdated
@lawrence-forooghian

Copy link
Copy Markdown
Contributor

Probably a question for the devex team but is there a way to force it to show something for a snippet even if it's not in the selected language? Else you have to keep flipping the language selector between JS and Swift to view the full page.

Comment thread src/pages/docs/push/live-activities.mdx Outdated
Comment thread src/pages/docs/push/live-activities.mdx Outdated
Comment thread src/pages/docs/push/live-activities.mdx Outdated
Comment thread src/pages/docs/push/live-activities.mdx Outdated
Comment thread src/pages/docs/push/live-activities.mdx Outdated
Comment thread src/pages/docs/push/live-activities.mdx Outdated
Comment thread src/pages/docs/push/live-activities.mdx
Comment thread src/pages/docs/push/live-activities.mdx Outdated
Comment thread src/pages/docs/push/live-activities.mdx Outdated
Comment thread src/pages/docs/push/live-activities.mdx Outdated
@ably-ci
ably-ci temporarily deployed to ably-docs-liveactivity--kmqavy July 10, 2026 09:04 Inactive
@ttypic
ttypic force-pushed the liveactivity-section branch from 3561365 to 009ead0 Compare July 10, 2026 10:10
@ably-ci
ably-ci temporarily deployed to ably-docs-liveactivity--kmqavy July 10, 2026 10:10 Inactive
@ttypic
ttypic force-pushed the liveactivity-section branch from 009ead0 to a59c5b0 Compare July 10, 2026 12:45
@ably-ci
ably-ci temporarily deployed to ably-docs-liveactivity--kmqavy July 10, 2026 12:45 Inactive
@ttypic
ttypic force-pushed the liveactivity-section branch from a59c5b0 to 216f0e8 Compare July 13, 2026 17:26
@ably-ci
ably-ci temporarily deployed to ably-docs-liveactivity--kmqavy July 13, 2026 17:26 Inactive
@ttypic
ttypic force-pushed the liveactivity-section branch 2 times, most recently from 416ae06 to fd272b0 Compare July 21, 2026 12:41
@ttypic ttypic added review-app Create a Heroku review app and removed review-app Create a Heroku review app labels Jul 21, 2026
@ably-ci
ably-ci temporarily deployed to ably-docs-liveactivity--cskzhj July 21, 2026 16:22 Inactive

@m-hulbert m-hulbert left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple of rewording and ordering suggestions.

Are we writing the getting started guide as part of this PR too?

Comment thread src/data/nav/pubsub.ts Outdated
link: '/docs/push/publish',
},
{
name: 'Live Activities',

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should match with the page title, so we either put iOS on both, or drop it on the title.

Comment thread src/pages/docs/push/live-activities.mdx Outdated
Comment thread src/pages/docs/push/live-activities.mdx Outdated
Comment thread src/pages/docs/push/live-activities.mdx Outdated
Comment thread src/pages/docs/push/live-activities.mdx Outdated

Keep both identifiers: `id` drives every later server call, and `apnsChannelId` is what devices subscribe to. `messageStoragePolicy: 1` tells APNs to cache the most recent broadcast for late joiners.

## Start a Live Activity <a id="start"/>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we have a short sentence explaining the options rather than 2 consecutive headings please?

Comment thread src/pages/docs/push/live-activities.mdx Outdated
Comment thread src/pages/docs/push/live-activities.mdx Outdated
Comment thread src/pages/docs/push/live-activities.mdx Outdated
Comment thread src/pages/docs/push/live-activities.mdx Outdated
Live Activities support is currently Experimental. APIs may change before general availability.
</Aside>

## How it works <a id="how-it-works"/>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this required to read before getting stuck in? Reading through it I'm guessing maybe the note is, but the other parts aren't - in which case I'd suggest it comes after the setup / using sections.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

put note near the code, moved section after the setup

@ably-ci
ably-ci temporarily deployed to ably-docs-liveactivity--cskzhj July 21, 2026 17:36 Inactive
@ably-ci
ably-ci temporarily deployed to ably-docs-liveactivity--cskzhj July 21, 2026 17:38 Inactive

@m-hulbert m-hulbert left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI failure is unrelated so I've re-run. Changes LGTM

Document starting, updating, and ending iOS Live Activities via Ably-managed APNs broadcast channels: device registration with push-to-start tokens, broadcast channel creation, the start/update/end server calls, and an aps payload and headers reference. Marked Experimental.

Co-authored-by: Mark Hulbert <39801222+m-hulbert@users.noreply.github.com>

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@ttypic
ttypic force-pushed the liveactivity-section branch from af0f274 to 2736e76 Compare July 22, 2026 09:30
@ably-ci
ably-ci temporarily deployed to ably-docs-liveactivity--cskzhj July 22, 2026 09:30 Inactive
@ttypic
ttypic merged commit 1000459 into main Jul 22, 2026
5 of 6 checks passed
@ttypic
ttypic deleted the liveactivity-section branch July 22, 2026 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

review-app Create a Heroku review app

Development

Successfully merging this pull request may close these issues.

5 participants