[DX-284] Flutter push notifications guide by maratal · Pull Request #3249 · ably/docs

maratal · 2026-03-05T15:13:26Z

Description

Flutter push notifications tutorial.

https://ably.atlassian.net/browse/DX-284

Checklist

Commits have been rebased.
Linting has been run against the changed file(s).
The PR adheres to the writing style guide and contribution guide.

coderabbitai · 2026-03-05T15:15:14Z

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: 528fa735-bcf9-4803-955b-e87b6c06bdff

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 DX-284-flatter-push-guide

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 and usage tips.}

m-hulbert · 2026-04-19T11:30:04Z

+Add the Google Services plugin to `android/build.gradle`:
+
+<Code>
+```kotlin


I'd make this (and the next one) text or shell otherwise we're mixing Kotlin with Flutter in this guide.

m-hulbert · 2026-04-19T11:32:55Z

+
+## Step 1: Set up Ably <a id="step-1"/>
+
+Create a new file `lib/ably_service.dart` to manage your Ably Realtime client across the app:


We've got a mix of 'realtime client' and 'Flutter SDK' in this guide too. We should be consistent with how we're referring to things.

replaced Realtime with Pub/Sub

m-hulbert · 2026-04-19T11:33:54Z

+```
+</Code>
+
+<Aside data-type='note'>


I think I had the same comments here as in the React Native guide.

moved to prereq

m-hulbert · 2026-04-19T11:35:21Z

+
+## Step 5: Send push with code <a id="step-5"/>
+
+The `ably_flutter` SDK does not implement the [Push Admin API](/docs/api/realtime-sdk/push-admin), so sending push directly to a `deviceId` or `clientId` from a Flutter client is not supported. Use the [Ably REST API](/docs/api/rest-sdk) from your backend server for direct push.


I don't think we need to state that an API isn't supported. We should just state how to use the REST API in this instance.

removed "Send push with code" step entirely

m-hulbert · 2026-04-19T11:35:58Z

+```
+</Code>
+
+Build and run the app again. Tap **Subscribe to Channel** first, then **Send Push to Channel** to send a push notification to all subscribed devices:


As per the other comment - we should ideally be separating out the publish and subscribe - so perhaps send via CLI and receive in-app to reflect a real-world scenario.

removed "Send push with code" step

m-hulbert · 2026-04-30T18:03:08Z

+```
+</Code>
+
+## Step 3: Test admin push notifications <a id="step-3"/>


I think my comments throughout are the same as those I just made for React native - though noting here that on both we should certainly rename this heading.

all addressed

m-hulbert

Approved with 1 quick fix to a codeblock!

m-hulbert · 2026-05-06T18:01:49Z

+Add the following dependencies to your `pubspec.yaml`:
+
+<Code fixed="true">
+```yaml


It seems yaml isn't supported properly as a language right now. Maybe switch this to text to get this PR sorted and I'll add support separately.

maratal added the review-app Create a Heroku review app label Mar 5, 2026

ably-ci temporarily deployed to ably-docs-dx-284-flatte-gskfom March 5, 2026 15:13 Inactive

ably-ci temporarily deployed to ably-docs-dx-284-flatte-gskfom March 5, 2026 22:52 Inactive

ably-ci had a problem deploying to ably-docs-dx-284-flatte-gskfom March 5, 2026 23:00 Failure

ably-ci had a problem deploying to ably-docs-dx-284-flatte-gskfom March 6, 2026 00:08 Failure

ably-ci temporarily deployed to ably-docs-dx-284-flatte-gskfom March 6, 2026 00:11 Inactive

ably-ci had a problem deploying to ably-docs-dx-284-flatte-gskfom March 7, 2026 17:35 Failure

maratal force-pushed the DX-284-flatter-push-guide branch from 04c81a6 to ebef656 Compare March 7, 2026 21:14

ably-ci temporarily deployed to ably-docs-dx-284-flatte-gskfom March 7, 2026 21:15 Inactive

ably-ci temporarily deployed to ably-docs-dx-284-flatte-gskfom March 8, 2026 17:28 Inactive

ably-ci temporarily deployed to ably-docs-dx-284-flatte-gskfom March 8, 2026 17:49 Inactive

ably-ci had a problem deploying to ably-docs-dx-284-flatte-gskfom March 8, 2026 18:18 Failure

ably-ci had a problem deploying to ably-docs-dx-284-flatte-gskfom March 8, 2026 22:02 Failure

maratal force-pushed the DX-284-flatter-push-guide branch from 5805594 to 0979304 Compare March 8, 2026 22:22

ably-ci temporarily deployed to ably-docs-dx-284-flatte-gskfom March 8, 2026 22:22 Inactive

maratal force-pushed the DX-284-flatter-push-guide branch from 0979304 to 0c443a9 Compare March 8, 2026 23:21

ably-ci temporarily deployed to ably-docs-dx-284-flatte-gskfom March 8, 2026 23:22 Inactive

ably-ci temporarily deployed to ably-docs-dx-284-flatte-gskfom March 9, 2026 01:16 Inactive

maratal changed the title ~~Add Flutter push notifications getting started guide~~ [DX-284] Flutter push notifications guide Mar 9, 2026

maratal force-pushed the DX-284-flatter-push-guide branch from b55cf04 to c2b509b Compare March 9, 2026 01:43

ably-ci temporarily deployed to ably-docs-dx-284-flatte-gskfom March 9, 2026 01:44 Inactive

maratal force-pushed the DX-284-flatter-push-guide branch from c2b509b to e486e5b Compare March 9, 2026 02:00

ably-ci temporarily deployed to ably-docs-dx-284-flatte-gskfom March 9, 2026 02:00 Inactive

maratal force-pushed the DX-284-flatter-push-guide branch from e486e5b to 1bfa5ff Compare March 9, 2026 03:03

ably-ci temporarily deployed to ably-docs-dx-284-flatte-gskfom March 9, 2026 03:03 Inactive

maratal marked this pull request as ready for review March 9, 2026 03:04

maratal requested a review from GregHolmes March 9, 2026 03:04

maratal requested a review from m-hulbert March 23, 2026 18:44

charlsteph8 assigned maratal Mar 24, 2026

m-hulbert reviewed Apr 19, 2026

View reviewed changes

maratal added review-app Create a Heroku review app and removed review-app Create a Heroku review app labels Apr 23, 2026

ably-ci temporarily deployed to ably-docs-dx-284-flatte-1f8a0f April 23, 2026 15:21 Inactive

ably-ci temporarily deployed to ably-docs-dx-284-flatte-1f8a0f April 23, 2026 15:42 Inactive

ably-ci temporarily deployed to ably-docs-dx-284-flatte-1f8a0f April 23, 2026 22:31 Inactive

maratal force-pushed the DX-284-flatter-push-guide branch from af7e997 to 92b5496 Compare April 23, 2026 23:00

ably-ci temporarily deployed to ably-docs-dx-284-flatte-1f8a0f April 23, 2026 23:01 Inactive

ably-ci temporarily deployed to ably-docs-dx-284-flatte-1f8a0f April 24, 2026 07:55 Inactive

maratal force-pushed the DX-284-flatter-push-guide branch from b093919 to 441c7a2 Compare April 26, 2026 22:35

ably-ci temporarily deployed to ably-docs-dx-284-flatte-1f8a0f April 26, 2026 22:36 Inactive

m-hulbert reviewed Apr 30, 2026

View reviewed changes

maratal force-pushed the DX-284-flatter-push-guide branch from 603d9b6 to a886f2e Compare May 3, 2026 20:10

maratal added review-app Create a Heroku review app and removed review-app Create a Heroku review app labels May 3, 2026

ably-ci temporarily deployed to ably-docs-dx-284-flatte-n0ycqk May 3, 2026 20:34 Inactive

maratal force-pushed the DX-284-flatter-push-guide branch from a886f2e to 20ae023 Compare May 3, 2026 21:28

ably-ci temporarily deployed to ably-docs-dx-284-flatte-n0ycqk May 3, 2026 21:28 Inactive

maratal force-pushed the DX-284-flatter-push-guide branch from 20ae023 to 9d0418e Compare May 6, 2026 15:14

ably-ci temporarily deployed to ably-docs-dx-284-flatte-n0ycqk May 6, 2026 15:14 Inactive

m-hulbert approved these changes May 6, 2026

View reviewed changes

maratal force-pushed the DX-284-flatter-push-guide branch from 9d0418e to 854df34 Compare May 6, 2026 19:50

ably-ci temporarily deployed to ably-docs-dx-284-flatte-n0ycqk May 6, 2026 19:50 Inactive

maratal force-pushed the DX-284-flatter-push-guide branch from 854df34 to 9d8e75d Compare May 6, 2026 19:51

ably-ci temporarily deployed to ably-docs-dx-284-flatte-n0ycqk May 6, 2026 19:51 Inactive

feat: Flutter push notifications getting started guide.

b6380f2

maratal force-pushed the DX-284-flatter-push-guide branch from 9d8e75d to b6380f2 Compare May 6, 2026 21:51

ably-ci temporarily deployed to ably-docs-dx-284-flatte-n0ycqk May 6, 2026 21:51 Inactive

maratal merged commit 04a4fa7 into main May 6, 2026
7 checks passed

maratal deleted the DX-284-flatter-push-guide branch May 6, 2026 22:10


		## Step 1: Set up Ably <a id="step-1"/>

		Create a new file `lib/ably_service.dart` to manage your Ably Realtime client across the app:


		## Step 5: Send push with code <a id="step-5"/>

		The `ably_flutter` SDK does not implement the [Push Admin API](/docs/api/realtime-sdk/push-admin), so sending push directly to a `deviceId` or `clientId` from a Flutter client is not supported. Use the [Ably REST API](/docs/api/rest-sdk) from your backend server for direct push.

Conversation

maratal commented Mar 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

coderabbitai Bot commented Mar 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

m-hulbert left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

maratal commented Mar 5, 2026 •

edited

Loading

coderabbitai Bot commented Mar 5, 2026 •

edited

Loading