Release Notes
activeWhat changed, when, and what it means for your integration.
What changed, when, and what it means for your integration. For the itemized, per-change list, see the Changelog.
Tracking API, 2026-10-05: any identifier in your identity strategy is enough
What changed: an Identify or Track call, a batch, or a CSV import row is
accepted when it carries at least one identifier from your workspace's
identity strategy: userId,
anonymousId, a device id in context.device, or, when enabled in the
strategy, a phone, email or custom identifier trait. userId and
anonymousId are no longer required on their own.
What it means for you:
- A call with no identifier now fails with
error.sdk.missing.identifier, noterror.sdk.missing.id. If your code matches on the old code, update it. - An empty string does not count as an identifier.
- A malformed phone or email can leave a call with none. It is dropped by the format check, and if it was the call's only identifier the call is rejected.
- In a batch, one event without an identifier rejects the whole batch, and nothing is stored.
- Event CSV imports accept
context.traits.*andcontext.device.*identifier columns. Import users before events: events don't update profiles.
The SDKs always send anonymousId, so SDK integrations are unaffected. No
SDK release is required.
See Limits & validation → Identifiers and CSV import.
Web SDK snippet 1.6.0, 2026-09-28: re-copy it to queue three more methods
What changed: the inline snippet in Track from the Web
now stubs sponsoredAds, joinTrace and leaveTrace, so calls to them made before
the SDK finishes loading are queued and replayed, like track and identify. The
snippet stubs 27 methods, in the order the SDK's loader uses, and its
SNIPPET_VERSION is now 1.6.0.
What it means for you: with a snippet copied before this change
(SNIPPET_VERSION 1.4.0 or earlier), calling Binoban.joinTrace(),
Binoban.leaveTrace() or Binoban.sponsoredAds() before the SDK has loaded throws
TypeError: Binoban.joinTrace is not a function. Calls made after the SDK has loaded
are not affected.
What to do: copy the snippet again, put back your own apiKey,
sourceIdentifier and host values, and check that your page now shows
SNIPPET_VERSION = "1.6.0". If you install with the npm package
@binoban/web-sdk, this note does not apply: the package keeps its own method list
in step with the SDK.
Tracking API, 2026-09-01: reserved names for context, identity and reachability
What changed: the fields Binoban fills in itself and the fields you send
no longer share one namespace. Every context field is now stored as an event
attribute under a reserved cx_ prefix — context.locale is stored as
cx_locale, context.page.url as cx_pageUrl — and a property or trait you
send under a name Binoban owns is dropped from the call rather than colliding
with it.
What it means for you:
locale,appName,pageUrland the other context names are now yours to use as ordinarytrackproperty names. Before this change they collided with the system attribute of the same name, and sending one on a brand-new event could stop that event from registering at all — after which every later call to the same event name went nowhere. If an event of yours "just never appeared" after you sent one of these, it works now.- The context attribute you picked in a segment is now labelled
cx_…. Existing segments, reports and exports keep working — they reference the attribute itself, not its label — but the name in the picker has changed, and any screenshot or runbook of your own that names one is now stale. - A trait named
userIdoranonymousIdin anidentifycall is ignored. Identity comes from the top-level field. These were already accepted and then went nowhere, so nothing that worked stops working — the behaviour is now documented rather than silent. - A trait named
smsReachable(oremailReachable,pushReachable,webPushReachable,customReachable) is ignored. Reachability is derived by Binoban. To change whether someone may be contacted on a channel, send the matchingsmsOptIn/emailOptIn/pushOptIn/webPushOptIn/customOptIntrait.
Nothing changes on the wire, and no SDK release is required. SDKs keep
sending context.locale, not cx_locale; only the name the attribute is
stored and queried under has changed. Existing event and profile data is
untouched.
See Track → Reserved property names, Identify → Read-only traits, and Limits & validation → Reserved names.
Web SDK — 2026-08-26 — a refused event is now reported as a failure
What changed: when the Binoban API refuses an event with a 4xx other than
429, the Web SDK now reports that event as a failed delivery. Previously
it reported such an event as delivered: the response body was never read,
and nothing distinguished a refusal from a success.
What it means for you: if you subscribe to the SDK's delivery events, or if you use a tool that does, a rejected event that used to appear healthy will now appear as a failure. Nothing about which events reach Binoban has changed — those events were already being refused. What changed is that the SDK now tells you so.
A refusal is not retried, because the server will refuse the same payload
every time; retrying would turn one bad event into ten identical rejected
requests against your own deployment. 5xx, 429 and network failures retry
exactly as before. See Retries.
Worth checking after you upgrade: if failure counts rise on a surface you believed was healthy, that is this change surfacing refusals that were already happening. To see why an event is being refused, start a trace and read its delivery log — the reason the server gives is stored nowhere else.
Trace sessions on the Web SDK
The Web SDK gains the trace session the Native and React Native SDKs already
have: joinTrace / leaveTrace / activeTraceSessionId / traceDeliveryLog,
plus a ?bnb_trace= URL parameter that starts a session with no code change at
all. See Trace a visitor.
1.0.0 — 2026-07-20 — first stable release (Native SDK)
This is the first stable release of the Binoban Native SDK (Android + iOS), and the release the compatibility matrix is pinned to.
Breaking change: apiHost is now required
What changed: apiHost no longer has a default. Earlier versions of the
Native SDK fell back to a hardcoded host if you didn't set one; 1.0.0 removes
that fallback.
What it means for you: if your existing integration relied on the default,
it will now initialize disabled (a safe no-op — it won't crash, but it also
won't send anything) until you set apiHost explicitly. Set it to
api.binoban.io for cloud, or your tenant's own host for on-prem/air-gapped.
See On-prem and the go-live checklist.
Deprecated APIs removed
1.0.0 begins Binoban's semantic-versioning commitment, so this release also
removes every API that had previously been marked deprecated — the last chance
to do so before a major-version bump would otherwise be required. If you only
used the standard Binoban(apiKey, sourceIdentifier) { … } factory and the
event methods (track, identify, flush, reset), you need no code change.
More resilient by default
- Failed uploads (network errors, rate-limiting, server errors) are now retried with backoff instead of being dropped outright; only a genuine client error drops a batch.
- Queued-but-unsent events now persist in your app's private storage rather than a temp directory, so they survive more restart/cleanup scenarios.
iOS additions
- A privacy manifest (
PrivacyInfo.xcprivacy) now ships with every framework slice. - Swift Package Manager is now available as a second distribution channel alongside CocoaPods.
- Device advertising signals (IDFA) are now included in event context when the user has authorized App Tracking Transparency.
Migration notes
- If you don't set
apiHosttoday, set it before upgrading — see On-prem for cloud vs. tenant-host guidance. - If you call a
screen,group, oraliasmethod directly, note these are internal, not part of the public method surface — see the Native SDK reference for the supported methods. - Everyone else: the standard factory and event methods are unchanged; no
action required beyond pinning to
1.0.0.
Per-surface status
| Surface | This release |
|---|---|
| Native SDK (Android + iOS) | 1.0.0 — first stable release |
| React Native bridge | 1.0.0 — released alongside the Native SDK |
| Web SDK | not yet on a public release version, see the compatibility matrix. Latest behaviour change: a refused event is reported as a failure (2026-08-26, above). Inline snippet: 1.6.0 (2026-09-28, above) |
| Tracking API | any identifier in the workspace's identity strategy is enough (2026-10-05, above); reserved cx_ context namespace and reserved property/trait names (2026-09-01, above) |
| Docs | cross-cutting reference pages filled in 2026-07-25 |
Next steps
- Changelog — the itemized log.
- Versioning — how Binoban's contract versioning works.
- Compatibility matrix — current versions and status per SDK.