Pushpad Push Integration with WorldVisa

This guide walks you through the entire process of configuring and using Pushpad with WorldVisa, from getting your credentials to sending your first notification. Pushpad is a web push service that supports sending notifications to all major browsers via FCM, Mozilla autopush, Windows Push Notification Services, and APNS, with just one simple API.

Configure Pushpad with WorldVisa

Before you can send notifications, you need to connect your Pushpad project to WorldVisa by getting your credentials and adding them to your integration settings.

Step 1: Get your Pushpad credentials

To configure the Pushpad integration, you need:

An active Pushpad account
A Pushpad auth token (found in the account settings)
Your Pushpad project ID (found in the project settings)

Open your Pushpad dashboard and sign in.

Create a project

Record the Project ID

Click Settings on the project page and record the Project ID. You need it to connect to WorldVisa.

Open access tokens

Navigate to the access token page.

Add access token

Generate a token in Pushpad and paste it into the integration form.

Create the token

Fill in the required fields to create a new access token, or use your existing token if you already have one.

Copy the token

Copy the generated token. You need it to connect to WorldVisa.

Step 2: Connect Pushpad to WorldVisa

Add these credentials to your Pushpad integration in the WorldVisa dashboard.

Open the WorldVisa Dashboard.

Open Integration Store

On the WorldVisa dashboard, navigate to the Integration Store.

Connect a provider

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

Select Push tab

Open the Push tab in the Integration Store.

Select Pushpad

In the Push tab, choose Pushpad from the provider list.

Paste credentials

In the Pushpad integration form, paste your access token and project ID from Step 1 into the corresponding fields.

Create the integration

Review your credentials, then click Create Integration to save.

Activity tracking

Pushpad supports push activity tracking. Enable the Push Activity Tracking toggle on the Pushpad integration, then forward events from your site. WorldVisa sends the WorldVisa message id as Pushpad custom_data. Pushpad passes that string only to action button callbacks. A tap on the notification body does not include it. Chrome is the only browser that shows action buttons, and it shows at most two. Add a button whose action matches a function on self.notificationActions. Leave custom_data as the value WorldVisa sets. Replacing it removes the message id.

{
  "actions": [
    { "title": "View", "action": "trackClick" }
  ]
}

You can set actions with a provider content override. In the service worker, customData is the message id:

self.notificationActions = {
  trackClick: function (customData) {
    return fetch("https://your-api.com/api/notifications/events", {
      method: "POST",
      headers: { "Content-Type": "application/json" },
      body: JSON.stringify({
        eventType: "clicked",
        eventId: customData,
      }),
    });
  },
};

Your backend then calls WorldVisa’s activity endpoint. delivered, opened, dismissed, and failed use the same eventId.

Using Pushpad with WorldVisa

Once your integration is configured, in other to send push notification using the PushPad provider, you must do the following:

Step 1: Add subscriber device token

After setting up the Pushpad SDK on your website, you must assign a user ID (uid) to your users’ push subscriptions. This uid is the identifier WorldVisa uses to target a specific browser. For example, if you use pushpad('uid', 'user123'), then user123 is the ID you must register in WorldVisa. You can do this by making an API call to update the subscriber’s credentials.

curl -L -X PUT "${WV_API_URL}/v1/subscribers/<SUBSCRIBER_ID>/credentials" \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H "Authorization: ApiKey ${WV_API_KEY}" \
-d '{
  "providerId": "pushpad",
  "credentials": {
    "deviceTokens": [
      "token1",
      "token2",
      "token3"
    ]
  },
  "integrationIdentifier": "pushpad-MnGLxp8uy"
}'

Step 2: Send a notification

Now you’re ready to send a push notification. Create a workflow with a Push step and then trigger it. WorldVisa sends the notification to the uids associated with the subscriber. The example below demonstrates a simple trigger using WorldVisa’s SDK.

curl --location "${WV_API_URL}/v1/events/trigger" \
--header 'Content-Type: application/json' \
--header "Authorization: ApiKey ${WV_API_KEY}" \
-d '{
    "name": "workflowId",
    "to": [
        "subscriberId"
    ],
    "payload": {}
}'

Getting Started

Integrate <Inbox />

Build a Workflow

Integrate Channels Providers

Account

Configure Pushpad with WorldVisa

Step 1: Get your Pushpad credentials

Step 2: Connect Pushpad to WorldVisa

Activity tracking

Using Pushpad with WorldVisa

Step 1: Add subscriber device token

Step 2: Send a notification

​Configure Pushpad with WorldVisa

​Step 1: Get your Pushpad credentials

​Step 2: Connect Pushpad to WorldVisa

​Activity tracking

​Using Pushpad with WorldVisa

​Step 1: Add subscriber device token

​Step 2: Send a notification

Configure Pushpad with WorldVisa

Step 1: Get your Pushpad credentials

Step 2: Connect Pushpad to WorldVisa

Activity tracking

Using Pushpad with WorldVisa

Step 1: Add subscriber device token

Step 2: Send a notification