Skip to main content

Getting Started Guide

This step-by-step guide walks you through setting up OCM Pulse for the first time, from creating your app to sending your first notification.

Overview​

By the end of this guide, you'll have:

  1. Created an app for your website
  2. Configured the Web Push channel
  3. Installed the SDK on your website
  4. Collected your first subscriber
  5. Sent your first notification

Estimated time: 15-30 minutes

Prerequisites​

Before you begin:

  • Access to OCM Pulse dashboard
  • Access to your website's code or CMS
  • HTTPS enabled on your website
  • A modern browser for testing

Step 1: Create Your App​

1.1 Navigate to Apps​

After logging in, click Apps in the main navigation.

1.2 Create New App​

Click Create App in the top right corner.

OCM Pulse Apps list highlighting the Create App button

1.3 Enter App Details​

FieldWhat to Enter
NameYour website name (e.g., "My Blog")
Site DomainFull URL (e.g., https://myblog.com)

Filling out the App Details form in OCM Pulse

1.4 Configure Settings (Optional)​

For your first app, you can skip advanced settings:

  • Leave frequency capping disabled
  • Use default notification settings

1.5 Create the App​

Click Create App. You'll be taken to the Channels page.

Step 2: Configure Web Push Channel​

2.1 Start Configuration​

On the Channels page, click Settings on the Web Push card.

Selecting the Web Push channel in the OCM Pulse dashboard

2.2 Permission Prompt Settings​

For getting started quickly:

SettingRecommended Value
Auto PromptEnabled
Delay5 seconds
Page Views3 (default)

2.3 Welcome Notification (Optional)​

Enable to greet new subscribers:

FieldExample
EnableYes
Title"Welcome!"
Message"Thanks for subscribing to our updates"
URLLeave blank or use your homepage

2.4 Default Assets (Optional)​

Upload your notification icon:

  • Size: 256×256 pixels
  • Format: PNG or JPG

You can skip this and use browser defaults initially.

2.5 Save Configuration​

Click Save. You'll be taken to the Installation page.

Step 3: Install the SDK​

3.1 Download Service Worker​

  1. On the Installation page, click Download Service Worker
  2. Save the ocm-push-worker.js file
  3. Upload it to your website's root directory

OCM Pulse SDK Installation page showing download and script options

Verify: https://yoursite.com/ocm-push-worker.js should be accessible.

3.2 Add the SDK Script​

Copy the embed code from the Installation page and add it to your website.

Option A: Add to <head> tag

<head>
  <!-- Your other head content -->
  <script src="https://ocm-push-domain.com/sdk/YOUR-APP-ID.js" defer></script>
</head>

Option B: Add before closing </body> tag

  <!-- Your page content -->
  <script src="https://ocm-push-domain.com/sdk/YOUR-APP-ID.js" defer></script>
</body>

3.3 Deploy Changes​

Push the changes to your website.

Step 4: Test Your Installation​

4.1 Open Your Website​

In a new incognito/private browser window, visit your website.

4.2 Wait for Prompt​

After the configured delay (5 seconds), you should see the permission prompt.

4.3 Subscribe​

Click Allow on the permission prompt.

4.4 Verify Subscription​

  1. Go back to OCM Pulse dashboard
  2. Navigate to your app's Subscriptions
  3. You should see your new subscription listed
tip

If you subscribed before, use incognito mode or clear your browser's notification settings for your site.

Step 5: Send Your First Notification​

5.1 Navigate to Triggers​

In your app, click Triggers in the menu.

5.2 Configure Manual Trigger​

Click Configure on the Manual Trigger card.

5.3 Create Your Notification​

Fill in the form:

FieldExample Value
Name"Test Notification"
Title"Hello from OCM Pulse!"
Body"Your push notifications are working correctly."
URLhttps://yoursite.com

Configuring a manual test notification in OCM Pulse

5.4 Send It​

  1. Ensure "Send Immediately" is selected
  2. Click Send Notification
  3. Confirm when prompted

5.5 Check Results​

  1. You should receive the notification on your device
  2. In OCM Pulse, go to Deliveries
  3. You'll see your notification with status "Success"

Congratulations!​

You've successfully:

  • ✅ Created an app
  • ✅ Configured Web Push
  • ✅ Installed the SDK
  • ✅ Collected a subscriber
  • ✅ Sent a notification

What's Next?​

Customize Your Prompts​

Configure permission prompts to increase opt-in rates.

Set Up Automation​

Configure RSS triggers to automatically notify subscribers about new content.

Target Your Audience​

Create segments to send relevant notifications to the right people.

Optimize Performance​

Run A/B tests to find the best notification content.

Troubleshooting​

Prompt Not Appearing​

  1. Check browser console for errors (F12 → Console)
  2. Verify service worker is accessible
  3. Ensure you're using incognito mode
  4. Check if notifications are blocked in browser settings

Notification Not Received​

  1. Check browser notification settings
  2. Verify you're subscribed in the dashboard
  3. Check Do Not Disturb settings
  4. Try a different browser

SDK Not Loading​

  1. Check the script URL is correct
  2. Verify no JavaScript errors are blocking it
  3. Ensure HTTPS is enabled
  4. Check browser console for network errors

Need Help?​

If you encounter issues:

  1. Check the troubleshooting sections in each guide
  2. Review the Web Push Installation guide
  3. Contact your administrator