Subscription preferences

Subscription → Preferences is where you set options for the subscription. The tabs are

• Platform updates
• Pulse keys

Platform updates

Choose how Magnolia handles critical platform updates for your project, such as infrastructure and Kubernetes changes.

1. Open Subscription → Preferences → Platform updates.
2. Select Tier 1, Tier 2, or Tier 3.
3. Click Update.

Pulse keys

A Pulse key lets your public site send Core Web Vitals. DX Cloud does not add the script for you. You create the key here, copy it once, and put it on the site. Collection starts when a visitor loads a page whose origin is on that key.

If Pulse keys is not in the list, ask an administrator for access to subscription preferences and Pulse keys.

1. Open Subscription → Preferences → Pulse keys.
2. Click Add.
3. Enter a Site name. This is the label in the list. It is not the browser origin. The name cannot contain spaces or other whitespace.
4. Add at least one Allowed origin, each on its own row. Each origin must be the exact origin a browser would send: http or https, a host, and a port only when it is not the default. No path, query, or trailing slash. https://www.example.com and http://localhost:3000 are valid. https://www.example.com/ is not.
5. Save. Copy the key from the dialog before you close it. The key is shown once and cannot be opened again.

The key accepts beacons only from the origins you listed. An origin already listed on another active key cannot be reused. Add www and the bare host as separate origins when both serve the site.

The list shows Site, Allowed origins, Status (Active or Revoked), and Expiry date. On this tab, the Status filter can limit the list to Active, Revoked, or both.

An active key can be edited. You can change the site name and the allowed origins. A revoked key cannot be edited.

Install the script

Install @magnolia/pulse on the public site. Set metrics to true. If you leave it unset, the script loads and collects nothing.

Set region to the collector for your subscription: eu-central, us-east, or ap-southeast.

npm install @magnolia/pulse

import Pulse from '@magnolia/pulse';

new Pulse({
  key: '<CLIENT KEY FROM COCKPIT>',
  region: 'eu-central',
  metrics: true,
});

Sites without a bundler load the same Pulse call from a script tag:

<script src="https://unpkg.com/@magnolia/pulse/dist/pulse.iife.js"></script>
<script>
  new Pulse({
    key: '<CLIENT KEY FROM COCKPIT>',
    region: 'eu-central',
    metrics: true,
  });
</script>

While you are checking the install, debug: true prints collection failures in the browser console. Leave it off on the live site. A failed beacon does not break the page.

Pulse sends one batch per full page load (the first view, a reload, or back/forward). It does not send a new batch when a single-page app changes the URL without loading a new document.

Confirm that visits are arriving

Open Web Vitals and check SDK adoption. Session share by SDK version lists the @magnolia/pulse versions that reported in the selected cluster, hosts, and dates. The page opens on the last week. An empty chart means no visit in that range came from a page running the script with this key.

Then use Overview for the five vitals. What each tab is for is on the Web Vitals guide.

Revoke a key

Revoke a key when it should stop reporting. Revoking sets the expiry to now. The row stays in the list with status Revoked. Any page still using that key can no longer send vitals. Create a new key and update the site if you still want collection.