Merge pull request #293 from im-perativa/staging

docs(pusher-beams): add pusher beams doc

channels-and-providers/push/pusher-beams.mdx

@@ -0,0 +1,48 @@
+---
+title: 'Pusher Beams'
+description: 'Learn how to use the Pusher Beams provider to send push notifications using Novu'
+---
+
+[Pusher Beams](https://pusher.com/beams/) is a cross-platform push notification API service provided by Pusher.
+
+To enable Pusher Beams integration, you need to create a Pusher Beams Instance and use both `Instance ID` and `Secret Key` from the Instance [dashboard](https://dashboard.pusher.com/beams/).
+
+# Setting the Device Token
+
+Once Pusher Beams instance has been created, and the Pusher Beams SDK has been [set up and configured](https://pusher.com/docs/beams/reference/all-libraries/) for your application, you can associate users with their devices using [Authenticated Users](https://pusher.com/docs/beams/guides/publish-to-specific-user/web/).
+
+This identifier allows targeting your user when sending push notifications without having to retrieve the specific Web, Android or iOS device tokens - which are managed by Pusher Beams.
+
+In order to target the Pusher Beams user from Novu, you must register the Pusher Beams Authenticated Users with their `userId` as the `deviceToken` for your Novu subscriber. This value can be retrieved via [getUserId()](https://pusher.com/docs/beams/reference/web/#getuserid) method from the SDK for your platform.
+
+Once you have the user's `userId` value, the `deviceToken` for your Novu subscriber can be set via:
+
+```jsx
+import { Novu, PushProviderIdEnum } from '@novu/node';
+
+const novu = new Novu("<NOVU_API_KEY>");
+
+await novu.subscribers.setCredentials('subscriberId', PushProviderIdEnum.PusherBeams, {
+  // Your user's unique 'userId' from Pusher Beams
+  deviceTokens: ['xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'],
+});
+
+```
+
+# SDK Trigger Example
+
+```jsx
+import { Novu } from '@novu/node';
+
+const novu = new Novu("<NOVU_API_KEY>");
+
+novu.trigger('event-name', {
+  to: {
+    subscriberId: '...',
+  },
+  payload: {
+    custom_data: 'custom_data', // the payload will be sent as notification data object. Cannot contain the key “pusher”
+  },
+});
+
+```

mint.json

@@ -274,7 +274,8 @@
             "channels-and-providers/push/apns",
             "channels-and-providers/push/expo-push",
             "channels-and-providers/push/onesignal",
-            "channels-and-providers/push/push-webhook"
+            "channels-and-providers/push/push-webhook",
+            "channels-and-providers/push/pusher-beams"
           ]
         },
         {