# Capacitor SDK Basic integration guide
This section contains information on how to integrate the Pushwoosh Capacitor SDK into your application.
## Prerequisites
To integrate the Pushwoosh Capacitor SDK into your app, you will need the following:
## Integration steps
### 1. Add Pushwoosh Capacitor SDK Dependency
Add the Pushwoosh Capacitor SDK dependency to your project:
```bash
npm install pushwoosh-capacitor-plugin
```
Sync the Capacitor configuration:
```bash
npx cap sync
```
### 2. Capacitor SDK Initialization
In your main `JavaScript` file, import and initialize the Pushwoosh SDK:
```javascript title="index.js"
import { Pushwoosh } from 'pushwoosh-capacitor-plugin';
// Initialize the SDK
Pushwoosh.onDeviceReady({
appid: "__YOUR_APP_CODE__"
});
// Register for push notifications
Pushwoosh.registerDevice()
.then(result => {
console.log("Push token:", result.pushToken);
// Handle successful registration
})
.catch(error => {
console.error("Failed to register device:", error);
// Handle registration error
});
```
Where:
- `__YOUR_APP_CODE__` is the application code from the Pushwoosh Control Panel.
### 3. iOS Native Setup
#### 3.1 Capabilities
To enable Push Notifications in your project, 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`.
If you intend to use Time Sensitive Notifications (iOS 15+), also add the `Time Sensitive Notifications` capability.
#### 3.2 Info.plist
In your `Runner/Info.plist` set the `__PUSHWOOSH_DEVICE_API_TOKEN__` key to the [Pushwoosh Device API Token](/developer/api-reference/api-access-token/#device-api-token):
```xml title="info.plist"
Pushwoosh_API_TOKEN__PUSHWOOSH_DEVICE_API_TOKEN__
```
#### 3.3 Message delivery tracking
You must add a Notification Service Extension target to your project. This is essential for accurate delivery tracking and features like Rich Media on iOS.
Follow the [native guide’s steps](/developer/pushwoosh-sdk/ios-sdk/setting-up-pushwoosh-ios-sdk/basic-integration-guide/#4-message-delivery-tracking) to add the extension target and the necessary Pushwoosh code within it.
### 4. Android Native Setup
#### 4.1 Install dependencies
Ensure that the required dependencies and plugins are added to your Gradle scripts:
Add the Google Services Gradle plugin to your project-level `build.gradle` dependencies:
```groovy title="android/build.gradle"
buildscript {
dependencies {
classpath 'com.google.gms:google-services:4.3.15'
}
}
```
Apply the plugin in your app-level `build.gradle` file:
```groovy title="app/build.gradle"
apply plugin: 'com.google.gms.google-services'
```
#### 4.2 Add Firebase configuration file
Place the `google-services.json` file into `android/app` folder in your project directory.
#### 4.3 Add Pushwoosh metadata
In your `main/AndroidManifest.xml` add [Pushwoosh Device API Token](/developer/api-reference/api-access-token/#device-api-token) inside the `` tag:
```xml title="AndroidManifest.xml"
```
> **Important:** Be sure to give the token access to the right app in your Pushwoosh Control Panel. [Learn more](/developer/api-reference/api-access-token/#edit-token)
### 5. Run the Project
1. Build and run the project.
2. Go to the Pushwoosh Control Panel and [send a push notification](/product/messaging-channels/push-notifications/send-push-notifications/one-time-push).
3. You should see the notification in the app.
## Extended integration
At this stage, you have already integrated the SDK and can send and receive push notifications. Now, let’s explore the core functionality
### Push notification event listeners
In the Pushwoosh Capacitor SDK there are two callback methods for handling push notifications:
- `pushReceivedCallback` is triggered when a push notification is received
- `pushOpenedCallback` is triggered when a user opens a notification
You should set up these callbacks right after initialization of the SDK:
```javascript title="index.js"
import { Pushwoosh } from 'pushwoosh-capacitor-plugin';
// Set up push received callback
await Pushwoosh.pushReceivedCallback((notification, err) => {
if (err) {
console.error("Failed to process received notification:", err);
} else {
console.log("Push received:", JSON.stringify(notification));
// Handle the received notification
}
});
// Set up push opened callback
await Pushwoosh.pushOpenedCallback((notification, err) => {
if (err) {
console.error("Failed to process opened notification:", err);
} else {
console.log("Push opened:", JSON.stringify(notification));
// Handle the opened notification
}
});
```
### User configuration
By focusing on individual user behavior and preferences, you can deliver personalized content, leading to increased user satisfaction and loyalty
```javascript
import { Pushwoosh } from 'pushwoosh-capacitor-plugin';
class Registration {
async afterUserLogin(user) {
// Set user ID
Pushwoosh.setUserId(user.getId);
// Setting additional user information as tags for Pushwoosh
await Pushwoosh.setTags({
"age": user.getAge(),
"name": user.getName(),
"last_login": user.getLastLoginDate()
});
}
}
```
### Tags
Tags are key-value pairs assigned to users or devices, allowing segmentation based on attributes like preferences or behavior, enabling targeted messaging.
```javascript
import { Pushwoosh } from 'pushwoosh-capacitor-plugin';
class UpdateUser {
async afterUserUpdateProfile(user) {
// Set list of favorite categories
await Pushwoosh.setTags({
"favorite_categories": user.getFavoriteCategoriesList()
});
// Set payment information
await Pushwoosh.setTags({
"is_subscribed": user.isSubscribed(),
"payment_status": user.getPaymentStatus(),
"billing_address": user.getBillingAddress()
});
}
}
```
### Events
Events are specific user actions or occurrences within the app that can be tracked to analyze behavior and trigger corresponding messages or actions
```javascript
import { Pushwoosh } from 'pushwoosh-capacitor-plugin';
class Registration {
// Track login event
afterUserLogin(user) {
Pushwoosh.postEvent("login", {
"name": user.getName(),
"last_login": user.getLastLoginDate()
});
}
// Track purchase event
afterUserPurchase(product) {
Pushwoosh.postEvent("purchase", {
"product_id": product.getId(),
"product_name": product.getName(),
"price": product.getPrice(),
"quantity": product.getQuantity()
});
}
}
```
## Troubleshooting
If you encounter any issues during the integration process, please refer to the [support and community](/developer/pushwoosh-sdk/support-and-community) section.