Documentation Release Notes - October 2026
October added a FAQ tab, a page that explains PubNub's latency figures, DataSync reference pages for six more SDKs, and documentation for category permissions in Access Manager.
The new FAQ tab collects short answers to common questions in one place. DataSync now has SDK reference pages for nine SDKs, continuing the work from September. The C SDK documentation was updated for version 1.1.0, which continues the new C SDK from September.
Platform 🛠️
Latency figures
Type: New feature
The new Latency page defines the three latency figures PubNub reports and shows where each one is measured. The figures cover different stretches of a message's journey, so they can't be compared with each other.
| Figure | Value | Measured between | Network transit |
|---|---|---|---|
| In-region overhead | Less than 0.5 ms | Ingestion of a message until it's ready for delivery to subscribers, inside one region | Excluded |
| Publish-processing | About 0.5 ms, same region | A publish request reaching PubNub until PubNub accepts and acknowledges it | Excluded |
| End-to-end delivery | About 57.79 ms average, about 64.97 ms across zones | Publisher to subscriber, wire to wire | Included |
The page also shows the measured one-way latency between selected PubNub regions, and which figure to use for which question, for example when you compare PubNub with another provider. It states that PubNub reports latency as observed and doesn't guarantee it contractually.
To measure latency in your own application, the page explains how timetokens expose it. This example estimates the subscriber's clock offset from PubNub server time, then measures the time from acceptance of a publish to receipt:
// Estimate the subscriber's clock offset from PubNub server time
const t0 = Date.now();
const { timetoken } = await pubnub.time();
const offsetMs = Number(timetoken) / 1e4 - (t0 + Date.now()) / 2;
pubnub.addListener({
message: (event) => {
const acceptedMs = Number(event.timetoken) / 1e4;
const latencyMs = Date.now() + offsetMs - acceptedMs;
console.log(`accept → receive: ${latencyMs.toFixed(1)} ms`);
},
});
Presence active and inactive events
Type: Update
The Presence events page now explains two channel-level events, active and inactive:
| Event | Fires when |
|---|---|
active | A channel gets its first occupant |
inactive | The last occupant leaves a channel |
These events don't reach your presence event listener. PubNub publishes them as messages on the keyset's Active Notice Channel, which you set in the keyset's Presence configuration. To receive them, subscribe to that channel like any other channel. To read them later, enable Include presence events in the Message Persistence settings and retrieve them from history.
The Events and Presence pages now describe the same behavior.
Subscribe filter expressions
Type: Update
The Server-side subscribe filter expressions page is now more precise about what a filter can read:
- A filter reads named fields only, such as
data.scoreormeta.region. A baredata.*ormeta.*isn't supported, so an expression likedata.* > 30isn't valid. - Always write the
data.ormeta.prefix. A name without a prefix, such aspublisher == "alice", currently resolves tometa.publisheron the server. The page now marks this as an unsupported fallback that may change, in Unprefixed field names. - The operators
>,<,>=, and<=accept numbers only. On a string, boolean, array, or object the result is undefined.
SDKs 📦
DataSync in six more SDKs
Type: New feature
In September we published the DataSync documentation, with SDK reference pages for JavaScript, C#, and Go. In October, DataSync reference pages were added for six more SDKs:
| SDK | DataSync reference |
|---|---|
| PHP | DataSync API for PHP SDK |
| Unity | DataSync API for Unity SDK |
| Dart | DataSync API for Dart SDK |
| Kotlin | DataSync API for Kotlin SDK |
| Java | DataSync API for Java SDK |
| Swift | DataSync API for Swift SDK |
Each page has the same structure: users, channels, memberships, entities, and relationships, each with create, get, get all, set, update, and remove methods, followed by real-time updates and projection channels. The Access Manager and Publish & Subscribe pages of these SDKs also cover DataSync permissions and DataSync listeners.
For example, this is how you create an entity in Swift:
pubnub.dataSync.createEntity(
className: "course",
classVersion: 1,
id: "course-swift-basics",
status: "draft",
payload: CourseDetails(
title: "Swift Basics",
lessonCount: 24,
isPublished: false,
summary: nil
)
) { result in
switch result {
case let .success(entity):
print("The created entity: \(entity)")
show all 19 linesThe Operations to permissions mapping page now also lists DataSync. It shows which resource type each kind of object needs (datasync:entities, datasync:relationships, datasync:memberships, users, or channels) and which permission each operation requires.
Category permissions in Access Manager
Type: New feature
Listing all channel or user metadata in App Context needs a different permission than reading one named channel or user. The Access Manager reference pages of 14 SDKs now document this as a category permission. The SDKs are JavaScript, Python, Asyncio, Ruby, PHP, Go, C#, Unity, Unreal, Dart, Kotlin, Java, C, and C-Core.
The rules, as described in the reference pages:
- A category permission lets a token list all metadata of one resource type on your subscribe key. The valid categories are
channelsanduuids. The only permission isget(32). - A
getpermission on one named channel or user, or on a pattern, doesn't grant a category. - A token can contain only categories. It needs no resource or pattern.
- When enumeration enforcement is enabled for a keyset, App Context list requests from a token or auth key without the matching category permission return a
403error.
This JavaScript example grants a client the permission to list all channel and user metadata:
const token = await pubnub.grantToken({
ttl: 15,
authorizedUserId: 'my-authorized-uuid',
categories: {
channels: { get: true },
uuids: { get: true },
},
});
The pages also show how the permissions appear after you parse a token, for example under a top-level categories key in JavaScript.
C SDK 1.1.0
Type: Update
The C SDK documentation was updated for version 1.1.0, a continuation of the new C SDK we introduced in September. The main changes:
- Clear a field. To delete a stored App Context value, pass
PUBNUB_CLEAR_VALUEinstead ofNULL. ANULLfield is omitted from the request and keeps its stored value. The SDK sends JSONnullfor a field set toPUBNUB_CLEAR_VALUE. The App Context page lists the fields that accept it. - Category permissions.
pubnub_grant_token()acceptschannels_category_permissionsanduuids_category_permissions, as described in Category permissions in Access Manager. - List active subscriptions.
pubnub_subscriptions(),pubnub_subscription_sets(), andpubnub_subscription_set_subscriptions()return the subscriptions and sets of a context. See List active subscriptions and sets. - Origin changes. The Configuration page now explains what
pubnub_set_origin()does to live subscriptions, heartbeats, and retries. See Origin changes. - Releasing a future. The Misc page now explains what
pubnub_future_release()does for queued and in-flight requests. See Releasing a future. - Custom OpenSSL location. The Environment setup page describes
PUBNUB_OPENSSL_LIB_DIR, which points the build to OpenSSL libraries in a non-standard location.
This excerpt clears the email and custom fields of the current user and leaves the other fields unchanged:
pubnub_set_uuid_metadata_opts_t opts = PUBNUB_SET_UUID_METADATA_OPTS_INIT;
opts.email = PUBNUB_CLEAR_VALUE;
opts.custom = PUBNUB_CLEAR_VALUE;
pubnub_future_t fut = pubnub_set_uuid_metadata(ctx, &opts);
FAQ ❓
FAQ tab
Type: New feature
The documentation has a new FAQ tab. Its content comes from the articles on our support pages. We reviewed them one by one, and each article ended up in one of three places:
- Some were removed because they were outdated or repeated what the docs already say.
- Some were moved into existing docs pages, and a few became new pages.
- The rest became the FAQ. It has nine categories and more than 150 questions, each with a short answer and links to the full docs.
The categories are Getting started, Architecture, Pub/Sub, Presence, Data storage, Logic, Security, Pricing, and Integrations.
The FAQ home page has a search box. Type a question and an AI assistant answers it on the page, using the FAQ answers first and the rest of the docs after that.
The docs are now the single source of truth. Pages that used to link to a support article, including about 240 SDK pages, now link to the matching docs page.