AblyDocs

Push

Open in

Use the ably push command group to manage push notifications. These commands enable you to publish notifications, manage channel subscriptions, configure push services, and manage device registrations.

Publish notifications

Use the following commands to deliver push notifications to devices, clients, or channels without requiring an active connection:

CommandDescription
ably push publishPublish a push notification to a device, client, or channel.
ably push batch-publishPublish push notifications to multiple recipients in a batch.

Manage push channels

Use the following commands to manage push notification channel subscriptions. Channel-based push uses a Pub/Sub model to broadcast notifications to all subscribed devices on a channel:

CommandDescription
ably push channels listList push channel subscriptions.
ably push channels list-channelsList channels with push subscriptions.
ably push channels saveSubscribe a device or client to push notifications on a channel.
ably push channels removeRemove a push channel subscription.
ably push channels remove-whereRemove push channel subscriptions matching filter criteria.

Manage push configuration

Use the following commands to configure push notification services for your app. These commands manage APNs and FCM credentials:

CommandDescription
ably push config showShow push notification configuration for an app.
ably push config set-apnsConfigure APNs push notifications for an app.
ably push config set-fcmConfigure FCM push notifications for an app.
ably push config clear-apnsClear APNs push notification configuration for an app.
ably push config clear-fcmClear FCM push notification configuration for an app.

Manage device registrations

Use the following commands to manage push notification device registrations. Device registrations track which devices are registered to receive push notifications:

CommandDescription
ably push devices listList push device registrations.
ably push devices getGet details of a push device registration.
ably push devices saveRegister or update a push device.
ably push devices removeRemove a push device registration.
ably push devices remove-whereRemove push device registrations matching filter criteria.

See also