Pusher Beams Push Integration with Novu

Connect Pusher Beams to Novu to send push notifications to iOS, Android, and web devices through workflows using your Pusher Beams instance ID and secret key.

Pusher Beams is a cross-platform push notification API service provided by Pusher.

This guide explains the process of configuring and using Pusher Beams with Novu, from getting your credentials to sending your first notification.

How to configure Pusher Beams with Novu

Before you can send notifications, you must get your credentials from a Pusher Beams instance and add them to your Novu integration settings.

Step 1: Get your Pusher Beams credentials

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.

1. Log in to Pusher Beams

   Open the Pusher Beams dashboard and sign in.

2. Create an instance

   Name your Pusher Beams instance, then click Create instance.

3. Name the instance

   Enter the instance name, and then click Create.

   
4. Copy credentials

   In the instance dashboard, click Keys from the sidebar, then copy and store your Instance ID and Primary key you will need them in Step 2.

   

Step 2: Connect Pusher Beams to Novu

Next, add these credentials to your Pusher Beams integration in the Novu dashboard.

1. Log in to the Novu dashboard

   Open the Novu Dashboard.

2. Open Integration Store

   On the Novu dashboard, navigate to the Integration Store.

3. Connect a provider

   In the Integration Store, click Connect provider to begin setup.

4. Select Pusher Beams

   In the Push tab, choose Pusher Beams from the provider list.

5. Paste credentials

   In the Pusher Beams integration form, paste your Instance ID and Secret Key into the corresponding fields.

   
6. Create the integration

   Review your credentials, then click Create Integration to save.

Using Pusher Beams with Novu

Once your integration is configured, you can start sending push notifications by registering your subscribers’ userId and triggering a workflow.

Step 1: Add subscriber device token

After setting up the Pusher Beams SDK in your application, you must associate users with their devices using Pusher Beams’ Authenticated Users feature. This assigns them a userId.

To target a Pusher Beams user from Novu, you must register this userId as the deviceToken for their Novu subscriber profile. You can retrieve this value using the getUserId() method from the Pusher Beams SDK.

You can do this by making an API call to update the subscriber’s credentials.

Node.js

import { Novu } from '@novu/api';
import { ChatOrPushProviderEnum } from "@novu/api/models/components";

const novu = new Novu({
  secretKey: "<NOVU_SECRET_KEY>",
  // Required if using EU region
  // serverURL: "https://eu.api.novu.co",
});

await novu.subscribers.credentials.update(
  {
    providerId: ChatOrPushProviderEnum.PusherBeams,
    integrationIdentifier: "pusher-beams-MnGLxp8uy",
    credentials: { deviceTokens: ["token1", "token2", "token3"] },
  },
  "subscriberId"
);

Python

import os
import novu_py
from novu_py import Novu

with Novu(secret_key=os.getenv("NOVU_SECRET_KEY", "")) as novu:
    novu.subscribers.credentials.update(
        subscriber_id="subscriberId",
        update_subscriber_channel_request_dto={
            "provider_id": novu_py.ChatOrPushProviderEnum.PUSHERBEAMS,
            "credentials": {"deviceTokens": ["token1", "token2", "token3"]},
            "integration_identifier": "pusher-beams-MnGLxp8uy",
        },
    )

Go

import (
    "context"
    "os"

    novugo "github.com/novuhq/novu-go"
    "github.com/novuhq/novu-go/models/components"
)

s := novugo.New(novugo.WithSecurity(os.Getenv("NOVU_SECRET_KEY")))

res, err := s.Subscribers.Credentials.Update(context.Background(), "subscriberId", components.UpdateSubscriberChannelRequestDto{
    ProviderID: components.ChatOrPushProviderEnumPusherBeams,
    IntegrationIdentifier: novugo.String("pusher-beams-MnGLxp8uy"),
    Credentials: components.ChannelCredentials{
        DeviceTokens: []string{"token1", "token2", "token3"},
    },
}, nil)

PHP

use novu;
use novu\Models\Components;

$sdk = novu\Novu::builder()->setSecurity('<NOVU_SECRET_KEY>')->build();

$sdk->subscribersCredentials->update(
    subscriberId: 'subscriberId',
    updateSubscriberChannelRequestDto: new Components\UpdateSubscriberChannelRequestDto(
        providerId: Components\ChatOrPushProviderEnum::PusherBeams,
        integrationIdentifier: 'pusher-beams-MnGLxp8uy',
        credentials: new Components\ChannelCredentials(
            deviceTokens: ['token1', 'token2', 'token3'],
        ),
    ),
);

.NET

using Novu;
using Novu.Models.Components;
using System.Collections.Generic;

var sdk = new NovuSDK(secretKey: "<NOVU_SECRET_KEY>");

await sdk.Subscribers.Credentials.UpdateAsync(
    subscriberId: "subscriberId",
    updateSubscriberChannelRequestDto: new UpdateSubscriberChannelRequestDto() {
        ProviderId = ChatOrPushProviderEnum.PusherBeams,
        IntegrationIdentifier = "pusher-beams-MnGLxp8uy",
        Credentials = new ChannelCredentials() {
            DeviceTokens = new List<string> { "token1", "token2", "token3" },
        },
    });

Java

import co.novu.Novu;
import co.novu.models.components.*;
import java.util.List;

Novu novu = Novu.builder().secretKey("<NOVU_SECRET_KEY>").build();

novu.subscribers().credentials().update()
    .subscriberId("subscriberId")
    .body(UpdateSubscriberChannelRequestDto.builder()
        .providerId(ChatOrPushProviderEnum.PUSHERBEAMS)
        .integrationIdentifier("pusher-beams-MnGLxp8uy")
        .credentials(ChannelCredentials.builder()
            .deviceTokens(List.of("token1", "token2", "token3"))
            .build())
        .build())
    .call();

cURL

curl -L -X PUT 'https://api.novu.co/v1/subscribers/<SUBSCRIBER_ID>/credentials' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: ApiKey <NOVU_SECRET_KEY>' \
-d '{
  "providerId": "pusher-beams",
  "credentials": {
    "deviceTokens": [
      "token1",
      "token2",
      "token3"
    ]
  },
  "integrationIdentifier": "pusher-beams-MnGLxp8uy"
}'

Step 2: Send a notification

Now you’re ready to send a push notification. Create a workflow with a Push step and trigger it. Novu sends the notification to the userId’s associated with the subscriber.

The example below demonstrates a simple trigger using Novu’s SDK.

Node.js

import { Novu } from '@novu/api';

const novu = new Novu({
  secretKey: "<NOVU_SECRET_KEY>",
  // Required if using EU region
  // serverURL: "https://eu.api.novu.co",
});

await novu.trigger({
  workflowId: "workflowId",
  to: {
    subscriberId: "subscriberId",
  },
  payload: {
    "custom_data": "custom_data"
},
});

Python

import os
import novu_py
from novu_py import Novu

with Novu(secret_key=os.getenv("NOVU_SECRET_KEY", "")) as novu:
    novu.trigger(trigger_event_request_dto=novu_py.TriggerEventRequestDto(
        workflow_id="workflowId",
        to={"subscriber_id": "subscriberId"},
        payload={
        "custom_data": "custom_data"
},
    ))

Go

import (
    "context"
    "os"

    novugo "github.com/novuhq/novu-go"
    "github.com/novuhq/novu-go/models/components"
)

s := novugo.New(novugo.WithSecurity(os.Getenv("NOVU_SECRET_KEY")))

res, err := s.Trigger(context.Background(), components.TriggerEventRequestDto{
    WorkflowID: "workflowId",
    To: components.CreateToSubscriberPayloadDto(components.SubscriberPayloadDto{
        SubscriberID: "subscriberId",
    }),
    Payload: map[string]any{
        "custom_data": "custom_data",
    },
}, nil)

PHP

use novu;
use novu\Models\Components;

$sdk = novu\Novu::builder()->setSecurity('<NOVU_SECRET_KEY>')->build();

$sdk->trigger(
    triggerEventRequestDto: new Components\TriggerEventRequestDto(
        workflowId: 'workflowId',
        to: new Components\SubscriberPayloadDto(subscriberId: 'subscriberId'),
        payload: [],
    ),
);

.NET

using Novu;
using Novu.Models.Components;

var sdk = new NovuSDK(secretKey: "<NOVU_SECRET_KEY>");

await sdk.TriggerAsync(triggerEventRequestDto: new TriggerEventRequestDto() {
    WorkflowId = "workflowId",
    To = To.CreateSubscriberPayloadDto(new SubscriberPayloadDto() { SubscriberId = "subscriberId" }),
});

Java

import co.novu.Novu;
import co.novu.models.components.*;

Novu novu = Novu.builder().secretKey("<NOVU_SECRET_KEY>").build();

novu.trigger()
    .body(TriggerEventRequestDto.builder()
        .workflowId("workflowId")
        .to(To2.of(SubscriberPayloadDto.builder().subscriberId("subscriberId").build()))
        .build())
    .call();

cURL

curl --location 'https://api.novu.co/v1/events/trigger' \
--header 'Content-Type: application/json' \
--header 'Authorization: ApiKey <NOVU_SECRET_KEY>' \
-d '{
    "name": "workflowId",
    "to": [
        "subscriberId"
    ],
    "payload": {
        "custom_data": "custom_data"
    }
}'