Capacitor SDK quick start

Get started with the Pushwoosh Capacitor SDK using this quick and simple example

To integrate the Pushwoosh Capacitor SDK into your app, you will need the following:

Clone the SDK repository:

git clone https://github.com/Pushwoosh/pushwoosh-capacitor-plugin.git

Navigate to the plugin directory:

cd pushwoosh-capacitor-plugin

Before running the example app, you need to build the Capacitor plugin.
Install plugin dependencies:

npm i

Build the plugin:

npm run build

Navigate to the example app directory:

cd example

Install the app dependencies:

npm i

Build the web assets:

npm run build

Open src/js/example.js and update the Pushwoosh.onDeviceReady call:

Pushwoosh.onDeviceReady({
    projectid: "__YOUR_FCM_SENDER_ID__",
    appid: "__YOUR_APP_CODE__"
});

Where:

__YOUR_APP_CODE__ is the application code from the Pushwoosh Control Panel. __YOUR_FCM_SENDER_ID__ is the Firebase project number from the Firebase Console.

Navigate to the iOS platform directory and install the CocoaPods dependencies:

cd ios/App
pod install --repo-update
cd ../..

After installing CocoaPods, sync the Capacitor configuration:

npx cap sync ios

Open the project in Xcode:

npx cap open ios

In Xcode, set the Bundle Identifier to your app’s package name (e.g., com.example.pushwoosh).

To enable Push Notifications, you need to add certain capabilities.

In the Signing & Capabilities section, add the following capabilities:

• Push Notifications
• Background Modes. After adding this capability, check the box for Remote notifications.

Open ios/App/App/Info.plist in Xcode and add the following entry with your Pushwoosh Device API Token:

<key>Pushwoosh_API_TOKEN</key>
<string>__YOUR_PUSHWOOSH_DEVICE_API_TOKEN__</string>

Sync the Capacitor configuration to the Android platform:

npx cap sync android

Copy your google-services.json file to the android/app directory.

Open android/app/build.gradle and set the applicationId to your app’s package name (e.g., com.example.pushwoosh).

Open your android/app/src/main/AndroidManifest.xml file and add the following metadata inside the <application> tag:

<meta-data android:name="com.pushwoosh.apitoken" android:value="__YOUR_PUSHWOOSH_DEVICE_API_TOKEN__" />

Replace __YOUR_PUSHWOOSH_DEVICE_API_TOKEN__ with your Pushwoosh Device API Token.

Open the project in Android Studio:

npx cap open android

1. Build and run the project.
2. Tap the “Click Me!” button.
3. Grant permission for push notifications. The device will be registered with Pushwoosh.

Go back to the Pushwoosh Control Panel and send a push notification to your registered device.