Capacitor quickstart

The plugin supports Capacitor 7 and 8 and exposes the native Pushctl iOS and Android SDKs through one TypeScript API.

Install and synchronize

npm install @pushctl/capacitor
npx cap sync

Complete native setup

Configure Firebase for Android. For iOS, enable the Push Notifications capability and forward both APNs registration callbacks from AppDelegate.swift. See native setup.

Initialize

import { Pushctl } from '@pushctl/capacitor';

await Pushctl.initialize({
  applicationKey: 'push_live_your_client_token',
});

Request permission

const permission = await Pushctl.requestPermission();

if (!permission.granted) {
  // Explain how to enable notifications in system settings.
}

Wait for confirmed registration

const subscription = await Pushctl.waitForRegistration();

if (!subscription.isRegistered) {
  throw new Error('Pushctl is not ready');
}

This resolves only after APNs or Firebase registration is confirmed by the Pushctl API. It rejects if native registration fails, the API rejects registration, or no native token arrives within 15 seconds.

Identify the signed-in user

await Pushctl.login({ externalUserId: user.id });

login() resolves only after the Pushctl API accepts the association. It rejects if the installation is not registered or the request fails.

Handle opens

const handle = await Pushctl.addListener('notificationOpened', notification => {
  if (notification.actionUrl) router.push(notification.actionUrl);
});

Call handle.remove() when the listener’s lifecycle ends.

Use a Client token. The application bundle contains values passed from JavaScript to the native plugin.

Migrate from another provider

Keep the existing provider enabled until waitForRegistration() resolves and login() succeeds. Permission alone does not prove that Pushctl has an active installation.

Choose an SDK

Android

iOS

Capacitor

Laravel

Migrate from another provider

​Migrate from another provider

Migrate from another provider