How the WordPress plugin works
activeThe plugin runs inside WordPress, with or without WooCommerce. In the visitor's browser it loads the Web SDK and captures interactions on its own. On the server, WordPress and WooCommerce hooks turn accounts, orders and form submissions into Identify and Track calls for the Tracking API. Server calls wait in a local queue and are sent in the background, so no visitor request waits on Binoban. To install it, see Deploy the WordPress plugin.
At a glance
Two collectors feed one Binoban workspace through two sources. The browser sends what only the browser sees: pages, clicks, scrolls, videos and forms being filled in. The server sends what must not be lost or faked: accounts, orders, payments, refunds and form submissions. Two cookies keep both paths on one person, and identity resolution runs per workspace, so both sources merge into the same profiles.
The parts
Everything is installed by the plugin. Nothing changes in the theme and nothing changes in Binoban.
| Part | What it does | Runs |
|---|---|---|
| Browser collector | Loads the Web SDK and the plugin's autocapture script, about 8 KB gzipped | On every front-end page, after consent if the site waits for it |
| Account collector | signed_up, logged_in, logged_out, password and profile events, Identify | On WordPress's own account hooks |
| Forms collector | form_submitted from seven form plugins, comment_submitted, product_reviewed | On each form plugin's after-submission hook |
| WooCommerce collector | Cart, checkout and order events, guest identity from billing fields | On WooCommerce hooks, including the Store API used by the Cart and Checkout blocks, and with HPOS |
| Identity check | Notices a logged-in user the browser doesn't know yet | Early in every request; reads two cookies and writes none unless the person changed |
| Queue | Holds server calls until they are sent; keeps sent ones 7 days and dead-letters 30 | The wp_binoban_queue table |
| Queue runner | Sends due calls in batches and retries failures | After any request that queued something, and every minute, through Action Scheduler (WooCommerce) or WP-Cron |
| Form identity endpoint | Receives the email and phone of a form no plugin hook reports, and sends them as Identify | POST /wp-json/binoban/v1/form-identity, at most 10 calls a minute per IP address |
| Admin | Setup, Connection, Identity, Events, Privacy, Health, Queue, Backfill, Trace a visit | Binoban menu in wp-admin |
binoban_settings, binoban_server_key, binoban_state | Settings; the Server key on its own, never loaded on front-end pages; pause state, scan results, backfill progress | WordPress options |
When events fire
Browser events fire as the visitor acts, in the page. Server events fire when
WordPress or WooCommerce runs the matching hook, so they are counted even when
the browser is blocked or the tab is closed: a buyer who never returns from the
bank gateway still produces order_completed.
| Where | What fires |
|---|---|
| A page loads | The page call, then the page event named after the page (about_us_viewed, post_viewed), then the page's own events: product_list_viewed, checkout_started, site_searched or products_searched. On a product or cart page the page event is product_viewed or cart_viewed itself |
| A single-page site changes route | The page call only |
| The visitor clicks | element_clicked for any link or button, plus outbound_link_clicked, file_downloaded, contact_clicked, product_clicked or promotion_clicked when the target is one |
| The visitor scrolls, watches, leaves | scroll_depth_reached at 25, 50, 75 and 100 %; video events; page_engaged when the tab is hidden or closed after 5 s of visible time |
| A form is used | form_started on the first focus; form_abandoned when the page is left without submitting; form_submitted (see Forms) |
| An account changes | signed_up, logged_in, logged_out, password_reset_requested, password_changed, profile_updated, account_deleted, each with an Identify where the profile changed |
| The cart changes | product_added, product_removed, coupon_applied, coupon_removed, coupon_denied |
| An order is created or moves | order_placed, then order_completed, order_payment_failed, order_cancelled, order_updated or order_refunded |
Nothing fires when: tracking is off; the person's role is excluded (Administrator and Shop manager by default), unless their browser is in a trace; the event is unticked on the Events tab; or the site waits for consent and the visitor hasn't given it (see Consent).
Event catalogue
Every event also carries the common properties listed under What an event carries. Connection says how it is sent: SDK by the visitor's browser to the Web source, API by WordPress to the Server source. WooCommerce events use Binoban's ecommerce events names and properties.
Pages and engagement
| Event | Connection | Fires when | Extra properties |
|---|---|---|---|
page call | SDK | Every page load and client-side route change | Category: the page type (page, post, product, category…). Name: the page's name. Properties: every page attribute |
<page>_viewed | SDK | Every page load; named after the page or its template (see Page events) | Every page attribute |
element_clicked | SDK | A click on a link, button or element with a click handler | element_tag, element_text (first 100 characters), element_id, element_classes, href (origin and path only), section (header, nav, footer or content) |
outbound_link_clicked | SDK | A link to another domain | url, domain, element_text |
file_downloaded | SDK | A link to a file type counted as a download (pdf, zip, rar, 7z, doc(x), xls(x), csv, ppt(x), apk, exe, dmg, mp3, mp4 by default) | file_url, file_extension |
contact_clicked | SDK | A tel:, mailto:, WhatsApp, Telegram or Bale link | channel (phone, email, whatsapp, telegram, bale), target |
scroll_depth_reached | SDK | 25, 50, 75 and 100 % of the page, each once per page view | depth_percent |
page_engaged | SDK | The tab is hidden or closed after at least 5 s of visible time; once per page view | engaged_seconds, max_scroll_percent, and the load timings |
video_played, video_progressed, video_completed | SDK | HTML5 video, or a YouTube or Vimeo embed | provider, video_url, title, duration_seconds; percent (25, 50, 75) on video_progressed |
site_searched | SDK | A WordPress search that isn't a product search | query, results_count |
Page events
Every page view fires one event named after the page, so a journey in Binoban
reads as home_viewed, shop_viewed, product_viewed, cart_viewed,
checkout_viewed rather than a row of identical page calls. It carries every
page attribute.
| Page | Named after | Event, for example |
|---|---|---|
| The home page (front page) | — | home_viewed |
| The posts page | — | blog_viewed |
| A WordPress Page | Its slug | about_us_viewed for /about-us/; team_viewed for /about-us/team/ |
| A Page whose slug isn't Latin (a Persian slug, for example) | Its template, else its ID | page_wide_viewed (template page-wide); page_14_viewed |
| A post, product or custom post type | Its custom template if it has one, else its post type | post_viewed, product_viewed, portfolio_viewed, single_with_sidebar_viewed |
| A category, tag or taxonomy archive | The taxonomy | category_viewed, tag_viewed, product_category_viewed, product_tag_viewed, product_attribute_viewed |
| A post type archive | The post type | portfolio_archive_viewed |
| Author, date, search and 404 pages | The page kind | author_viewed, date_archive_viewed, search_results_viewed, not_found_viewed |
| WooCommerce pages | The store page, and the account section | shop_viewed, cart_viewed, checkout_viewed, order_received_viewed, my_account_viewed, my_account_orders_viewed |
Names are snake_case, at most 64 characters, and never start with bb_.
- Rename or switch off any of them on the Events tab, in the Page events
table, which lists every kind of page on the site with its event (see
Deploy). A page switched off still sends its
pagecall. - No double counting. When a page's event has the name of a standard event,
that event carries the page attributes instead of a second event being sent:
a product page sends one
product_viewedwith the product's and the page's attributes, and the cart page onecart_viewed. The checkout page sendscheckout_viewed(the page) andcheckout_started(the funnel step). - A single-page site's route changes send the
pagecall only, withpage_type: client_routeand what the browser can see, because WordPress didn't render that page. - The whole set can be switched off with
<page>_viewedin the Pages and engagement group.
Account
| Event | Connection | WordPress signal | Extra properties |
|---|---|---|---|
signed_up | API | user_register | method, role, source_plugin |
logged_in | API | wp_login, or the identity check | method, source_plugin |
logged_out | API | wp_logout | — |
password_reset_requested | API | retrieve_password | — |
password_changed | API | after_password_reset, or a profile save with a new password | — |
profile_updated | API | profile_update, when a profile field actually changed | changed_fields (names only) |
account_deleted | API | delete_user | — |
method is password, otp, social or unknown, from which known plugin ran
the login; source_plugin names it (for example digits).
Forms
| Event | Connection | Fires when | Extra properties |
|---|---|---|---|
form_started | SDK | First focus in a form | form_id, form_name, form_plugin, page_path |
form_submitted | API, or SDK for an unknown form | A form plugin's after-submission hook; the browser's submit for a form no hook reports | form_id, form_name, form_plugin, field_names, has_email, has_phone, page_path |
form_abandoned | SDK | The page is left after form_started without a submit | form_id, last_field_name, fields_completed |
comment_submitted | API | comment_post on anything but a product | post_id, post_type, is_reply |
The form plugins with a server hook are Contact Form 7, Gravity Forms, WPForms, Elementor Pro Forms, Fluent Forms, Formidable Forms and Ninja Forms. Search forms, the add-to-cart form, the cart, checkout, login, registration and comment forms are not reported as forms; they have their own events.
WooCommerce: browsing
| Event | Connection | Fires when | Extra properties |
|---|---|---|---|
products_searched | SDK | A product search | query |
product_list_viewed | SDK | A shop, category, tag or brand archive, or product search results | list_id, category, products (the first 40 shown, each with position) |
product_list_filtered | SDK | The same, with filter, price, rating or sort parameters in the URL | list_id, category, filters, sorts, products |
product_clicked | SDK | A product in a list or widget is clicked | product_id, url, list_id, and the product's properties and position when it was in the list |
product_viewed | SDK | A single product page | Product properties |
promotion_viewed, promotion_clicked | SDK | A block with the class bnb-promotion is half in view, or clicked. Off until switched on | promotion_id (the block's anchor), name, creative, position |
WooCommerce: cart and checkout
| Event | Connection | WooCommerce signal | Extra properties |
|---|---|---|---|
product_added | API | woocommerce_add_to_cart: classic, AJAX and Store API | Product properties, cart_id, quantity |
product_removed | API | woocommerce_cart_item_removed | Product properties, cart_id, quantity |
cart_viewed | SDK | The cart page is shown with items | cart_id, products, revenue, total, shipping, tax, discount, coupon, currency |
checkout_started | SDK | The checkout page is shown with items | Same as cart_viewed |
coupon_applied | API | woocommerce_applied_coupon | cart_id, coupon_id, coupon_name, discount |
coupon_removed | API | woocommerce_removed_coupon | cart_id, coupon_id, coupon_name |
coupon_denied | API | A coupon validation error | cart_id, coupon_id, coupon_name, reason, error_code |
order_placed | API | The order is created at checkout, before payment (classic and blocks) | Order properties |
WooCommerce: orders
| Event | Connection | WooCommerce signal | Extra properties |
|---|---|---|---|
order_completed | API | woocommerce_payment_complete, or the first move to processing or completed. Once per order | Order properties |
order_payment_failed | API | Status moves to failed | Order properties |
order_cancelled | API | Status moves to cancelled | Order properties |
order_updated | API | Any other status change | order_id, previous_status, to_status, total, currency |
order_refunded | API | woocommerce_order_refunded | order_id, refund_id, refund_amount, is_full_refund, total, currency |
product_reviewed | API | comment_post on a product | product_id, review_id, rating |
product_added_to_wishlist, product_removed_from_wishlist | API | YITH WooCommerce Wishlist | Product properties, wishlist_id |
order_completed is guarded by a flag on the order, so a payment callback and
a status change for the same order never send it twice.
Identify
Identify calls carry the person's traits. They are sent at sign-up
and login, when a profile field changes, at checkout (guests too) and when a form
with an email or phone field is submitted. In Binoban they appear as
bb_identify events on the profile.
Who an event belongs to
The plugin never depends on how a site logs people in. Every login method, whether password, phone and OTP, magic link or social, ends with WordPress knowing the current user, and the plugin keys on that.
| Situation | userId | anonymousId | Effect in Binoban |
|---|---|---|---|
| Anonymous visitor | — | The Web SDK's ID | An anonymous profile |
| Signs up or logs in, any method | wp_<user id> | The Web SDK's ID | Identify links the anonymous history to the person |
| Guest checkout | — | The Web SDK's ID, saved on the order | Identify carries the billing phone and email; merges once phone or email is in the workspace strategy |
| Guest with no browser ID (backfill, an order made in wp-admin) | — | wpguest_<hash> of the billing phone or email | One profile per guest across their orders |
| Form with an email or phone field | — or wp_<user id> | The Web SDK's ID | Identify with those traits only, never the other field values |
| Logs out | — | A new ID | The browser resets, so the next person on the device starts fresh |
| Second device | wp_<user id> | A different ID | One profile, because the userId is the same |
userId is the WordPress user ID with a wp_ prefix. It never changes, even
when the person changes phone or email. On the Identity tab, userId can name a
user meta key instead, such as a customer code, so the site's profiles match the
IDs a mobile app or CRM already sends; a user without a valid value there keeps
wp_<user id>. See Identity strategy.
How a login is detected
- Hooks.
user_registerandwp_loginfire for core WordPress login and for most OTP and social plugins, which call the same WordPress functions. - Identity check. On every request, a logged-in user whose
bnb_uidcookie is missing or different is treated as a login: Identify,logged_inwithmethod: unknown, and the cookie is set. This catches plugins that log people in without firingwp_login. - Method.
methodcomes from which known plugin's hook or request ran: Digits, Login with phone number and Aryabyte OTP giveotp; Nextend Social Login givessocial; a password form givespassword.
The two cookies
| Cookie | Set by | Holds | Read by |
|---|---|---|---|
bob_anonymous_id | The Web SDK | The browser's anonymous ID | The server, which puts it on every server event from that browser and saves it on orders |
bnb_uid | The plugin, at login | The userId only, no personal data. Lasts as long as a remembered login, otherwise 30 days; cleared at logout | The browser, which calls Identify with it, and calls reset when it disappears |
Page HTML never contains a user's identity, so full-page caches can serve the same page to everyone. Traits such as phone and email go only server to server.
Identifiers found automatically
| Identifier | Where the plugin looks | Normalisation |
|---|---|---|
| Phone | Known meta keys first (digits_phone, billing_phone, the login plugins' own keys), then any user meta key whose values mostly look like mobile numbers | Persian and Arabic digits to Latin; a leading 0 or 00 to E.164 with the default country code, for example +989121234567. Iranian numbers must be mobiles |
user_email, then billing_email | Lower-cased; skipped when it looks like a placeholder a phone-login plugin made up (mostly digits, the phone number, or a dummy domain) | |
| Name | first_name / last_name, then the billing names | firstName / lastName, 32 characters at most |
| Custom | Any user meta key added on the Identity tab | Sent as a trait under the key's name |
The scan runs at setup and again every week. A field that appears later, for example after a login plugin change, is flagged on the Health tab and is not used until an admin ticks it.
What an event carries
Common properties
On every Track event:
| Property | Meaning |
|---|---|
event_id | A unique ID for this event, so a retry can be de-duplicated |
source | wordpress_browser or wordpress_server |
connection | SDK or API: how the event was sent |
site_url, site_language | The site's home URL and locale |
plugin_version | The plugin version that sent it |
schema_version | 1; it changes only with breaking changes |
logged_in | Whether the person was logged in |
historical | true on backfilled events |
truncated, dropped_fields | Only when the size guard removed properties |
On Identify, event_id, source, connection, schema_version and
historical are in context instead. Server events also carry
context.ip, context.userAgent, context.locale and, during a trace,
context.traceSessionId. Browser events carry the Web SDK's own context, with
page URLs reduced to origin, path and the allowed parameters.
The event's timestamp is the time of the action, never the send time, so events delayed by an outage keep their real time and order in Binoban. Backfilled events keep the user's registration date or the order's payment date.
Page attributes
The page call and the page event carry everything below that applies to the
page. Empty values are left out, lists hold at most 20 items and text at most
300 characters. The server attributes describe the page, not the visitor, so
they are the same for everyone and safe in cached HTML; the browser adds the
rest when the page is shown.
Every page (server)
| Property | Meaning |
|---|---|
page_type | front_page, blog, page, post, product or another post type, category, tag, taxonomy, post_type_archive, author, date_archive, search, not_found, shop, cart, checkout, order_received, my_account |
page_key, page_name, page_event | The key the Page events table uses (page:12, single:post, woo:cart), the page's name, and the page event it fires |
site_name, language, text_direction, blog_id | The site, its language (Polylang or WPML when active), rtl or ltr, and the site ID on multisite |
is_front_page, is_singular, is_archive, is_search, is_404 | What kind of page it is |
theme, parent_theme | The active theme, and its parent when it is a child theme |
template, template_file, template_source | The template that rendered the page (single-product, page, archive), its file for classic themes, and where it came from: block_theme, theme, parent_theme or plugin |
page_template, template_name | A custom template assigned to the post, and its name |
A page, post, product or custom post type (server)
| Property | Meaning |
|---|---|
post_id, post_type, post_slug, post_title, post_status, post_format | The post itself |
published_at, modified_at | ISO 8601, UTC |
author_id, author_name | The author's ID and public display name |
word_count, reading_minutes | Words in the content, and minutes to read at 200 a minute |
excerpt | The excerpt, or the first 40 words; never for a password-protected post |
comment_count, comments_open, menu_order, is_sticky, password_protected | As in WordPress |
has_featured_image, featured_image_url | The featured image |
canonical_url | The post's canonical URL |
parent_id, parent_title, ancestor_ids, breadcrumb, page_depth | Where it sits in the page hierarchy, e.g. About us > Our team |
categories, category_ids, tags | Categories and tags (product categories and tags on products) |
primary_category | The primary category set in Yoast SEO or Rank Math |
tax_<taxonomy> | Terms of every other public taxonomy on the post type |
focus_keyword, seo_noindex | The focus keyword and noindex setting from Yoast SEO or Rank Math |
builder, elementor_template_type | How the content was built: elementor, divi, beaver_builder, wpbakery, blocks or classic |
blocks, block_count | The block types used (core/heading, woocommerce/product-collection) and how many blocks |
page_number, total_pages | For a post split with Page break |
An archive, the blog, search results or the shop (server)
| Property | Meaning |
|---|---|
term_id, term_name, term_slug, taxonomy, term_count, term_description | The category, tag or term shown |
term_parent_id, term_parent_name, breadcrumb, term_depth | Where the term sits, e.g. News > Company news |
results_count, items_shown, item_ids | How many items match, how many are on this page, and the first 20 IDs |
page_number, total_pages, posts_per_page, orderby, order | Pagination and sorting |
archive_post_type, author_id, author_name, archive_year, archive_month, archive_day | For post type, author and date archives |
search_query, search_results_count, search_post_type | On search results |
WooCommerce (server)
| Property | Meaning |
|---|---|
woo_page, account_endpoint | shop, product, product_category, product_tag, cart, checkout, order_received or my_account, and the account section (orders, edit-address…) |
product_id, product_type, sku | On a product page |
price, regular_price, sale_price, on_sale, min_price, max_price, currency, store_currency | Prices, in Rial for Toman stores (see Products and money); min_price and max_price for variable products |
stock_status, stock_quantity, purchasable, sold_individually | Availability; the quantity only when stock is managed |
average_rating, review_count, featured, virtual, downloadable | As in WooCommerce |
weight, length, width, height, shipping_class | Shipping details |
variation_count, gallery_image_count, upsell_count, cross_sell_count, brand | More product facts |
attr_<attribute> | Each attribute's values, e.g. attr_color: ["Navy"]. An attribute whose name isn't Latin becomes attr_attribute_1, attr_attribute_2… |
Custom fields (server). With Advanced Custom Fields, each field on the
post or term is sent as acf_<field name>: up to 30 fields of the content
types text, text area, number, range, select, checkbox, radio, button group,
true/false, date and time pickers, colour picker, URL, link, taxonomy (names),
post object, page link and relationship (titles), and image (URL).
The rendered page (browser)
| Property | Meaning |
|---|---|
document_title, meta_description, meta_keywords, robots, canonical_url | What the page's <head> says, whichever SEO plugin wrote it |
og_type, og_title, og_image | Open Graph tags |
schema_types | The JSON-LD types on the page, e.g. Product, BreadcrumbList, FAQPage |
h1, h2_count, h3_count | The first heading and how many sub-headings |
image_count, video_count, iframe_count, form_count, button_count | What the page contains |
link_count, internal_link_count, external_link_count | Links to this site and to others |
page_height | The page's height in pixels |
The visitor's device and visit (browser)
| Property | Meaning |
|---|---|
viewport_width, viewport_height, screen_width, screen_height, device_pixel_ratio, orientation, touch | The screen |
color_scheme, browser_language, timezone | Dark or light mode, the browser's language and time zone |
connection_type, save_data | The network (4g, 3g…) and data-saver mode |
navigation_type | navigate, reload, back_forward or prerender |
session_page_number, is_landing_page, previous_page_path | Where this page falls in the visit, in this tab: its number, whether it's the first, and the previous page on the site |
Sites can add or change server attributes with the binoban_page_properties
filter.
Load timings
page_engaged also carries how fast the page loaded, in milliseconds from the
start of navigation: ttfb_ms (time to first byte), dom_interactive_ms,
dom_content_loaded_ms, load_ms, lcp_ms (largest contentful paint), and
transfer_kb, the page's size over the network.
Products and money
| Shape | Properties |
|---|---|
| Product | product_id (the parent product), sku, name, category, brand, price, currency, url, image_url; variant and variant_id for a variation |
| Order | order_id, order_number, checkout_id, affiliation, subtotal, total, revenue, shipping, tax, discount, coupon, payment_method, status, currency, and products with quantity and line price |
Prices are what the shopper is shown. A Toman store sends amounts in Rial:
IRT ×10 (thousand-Toman and thousand-Rial currencies are converted too), with
currency: IRR and the store's own currency in store_currency. This can be
switched off on the Privacy tab.
Traits
Sent on Identify.
| Trait | From | Rule |
|---|---|---|
phone | The first ticked phone field with a value | E.164, see Identifiers found automatically |
email | user_email, else billing_email | Lower-cased; placeholders skipped |
firstName, lastName | Profile name, else billing name | 32 characters at most |
| custom traits | User meta keys added on the Identity tab | Sent as text |
Opt-in rule: the plugin never opts anyone in, and never sends emailOptIn
or smsOptIn by itself. A site that records opt-outs can add them with the
binoban_user_traits filter.
Size guard
Binoban accepts at most 8 KB per event. A larger event drops properties in this
order: texts over 256 characters, products beyond the first 20, then the largest
remaining values that aren't core (event_id, source, connection, the site
and version properties, order_id, product_id, total, revenue,
currency). It then gets truncated: true and dropped_fields. If Binoban
still answers 413, the event is shrunk once more, and if it still doesn't fit it
becomes a dead-letter instead of being lost silently.
Browser events have the same limit. A page event that would pass 6.5 KB drops,
in this order, custom fields, the block list, the excerpt, other taxonomies,
item IDs, the term description, schema types, product attributes, and the
meta and Open Graph texts, and is marked truncated with dropped_fields.
Delivery
Browser events are sent by the Web SDK, which retries on its own: up to 10 attempts, holding up to 100 events in the browser while offline. Everything below is about server events.
Each server event is checked against Binoban's
rules first. A property whose name breaks
them (a disallowed character, over 64 characters, a cx_ prefix or a reserved
name) is dropped, and text values are capped at 2,048 characters. An event with
an invalid name (including a bb_ prefix), an invalid userId, or no userId
or anonymousId is never queued, because Binoban rejects a whole batch when one
event lacks an identifier. The rest are written to the queue during the request
and sent by the runner. Delivery is
at least once: nothing is dropped while Binoban is down, and a retry after a
timeout can arrive twice, with the same event_id.
| Binoban response | What the plugin does |
|---|---|
| 200 | Marked Sent. The row is kept 7 days as a record of exactly what was sent |
| 401 or 404 (wrong key, unknown source) | Pauses sending and shows a banner with the reason. Events keep queuing. A passing Test connection lifts the pause |
| 413 (too large) | The batch is split; a single event is shrunk and resent, and if it still doesn't fit, dead-letter |
| Other 4xx (Binoban rejected the content) | The batch is split until the bad event is alone; it becomes a dead-letter with Binoban's error code and is never retried |
| 5xx, 429, timeout, DNS or certificate error | Retried after 1, 2, 5, 15, 30 and 60 minutes, then hourly; Binoban's Retry-After is honoured. After 24 hours it becomes a dead-letter |
Each request to Binoban has a 10-second timeout.
Order
Calls for one person (userId, else anonymousId) go out in the order they
happened: once a person has a call waiting for a retry, their later calls wait
behind it rather than overtaking. Calls are sent in runs of one kind, Identify or
Track, in queue order. Different people don't hold each other up.
When waiting calls are sent
- At the end of any request that queued an event, the runner is scheduled to run in the background.
- Every minute, through Action Scheduler when WooCommerce is active, otherwise WP-Cron.
- In batches of up to 100 events and 800 KB. A run starts no new batch after 9 seconds, so it stays under 20 seconds and never competes with traffic.
- Drain now on the Queue tab.
WP-Cron only runs when someone visits the site. The Health tab warns when events
have waited more than 15 minutes; a low-traffic site should call wp-cron.php
from a server cron job.
Housekeeping
Sent rows are deleted after 7 days and dead-letters after 30, once a day. A dead-letter can be sent again with Retry selected on the Queue tab once its cause is fixed.
Backfill
A backfill loads what existed before the plugin. Start it on the Backfill tab.
- Each existing user becomes one Identify, with their registration date as the
timestamp and
historical: true. - Each processing or completed order becomes one
order_completed, with its payment date (or creation date) as the timestamp andhistorical: true; a guest order also sends an Identify with the billing traits. Orders already sent live are skipped. - Users load 100 at a time and orders 50 at a time, users first, into the same queue, so they share retries and ordering with live events.
- It runs in the background and can be paused and resumed.
Backfilled users are sent with their traits as they are now. History before the plugin, such as page views, can't be recovered.
Consent
| Mode | Browser | Server |
|---|---|---|
| Always on | The SDK loads on every page | All events |
| Wait for consent | The SDK loads only after the WP Consent API reports statistics consent; marketing consent is needed for Identify | Account and order events for logged-in users; guest events only with consent. A non-consenting guest's order is dropped, or sent without the browser's ID if the Privacy tab says so |
What is never sent
These rules are always on. An admin can tighten them but can't switch them off.
- Form field values, except the email, phone and name used for identity. Those go to the site's own server and on to Binoban as Identify only.
- Anything in password, card, IBAN, national-ID or hidden fields. The browser collector records clicks, never keystrokes.
- Text inside elements with the class
bnb-ignore. Add it to any block in the editor under Advanced → Additional CSS class(es). - URL credentials. The SDK is loaded with
pageContext: "sanitized"andreferrer: "origin", so onlyutm_*,btid,uridand an allowlist survive:s,orderby,min_price,max_price,post_type,product_cat,product_tag,paged,rating_filter, onefilter_andquery_type_entry per WooCommerce attribute, and any extra names set on the Privacy tab. Link URLs in click events keep only origin and path. - Custom fields that may hold personal or secret data. ACF email, password, user, rich-text (WYSIWYG), file, gallery, oEmbed, Google Map, repeater, group and flexible-content fields are never sent. Custom fields outside ACF are never read.
- Activity of excluded roles, Administrator and Shop manager by default.
- The Server key. It is stored in its own WordPress option and never written into a page, a cookie or a REST response. The Web key is public by nature.
Deleting the plugin removes its settings, queue table, scheduled jobs and order flags. Data already sent to Binoban stays there.
Limits and known gaps
- Versions: WordPress 6.0+, PHP 7.4+, and WooCommerce 8.0+ for store events. Multisite works per site; there is no network-wide setting.
- Not in this version: rendering Sponsored Products or Display Ads, catalog sync, web push, Aparat video, and LMS or membership events.
- The Web key can't be tested from WordPress. The Web SDK signs its own payload, so a key is only proven by a browser's first event. Use Trace a visit.
- Phone and email matching need the workspace identity strategy. Until then, guests and form leads stay on their anonymous profiles.
- An unknown login plugin still works through the identity check, but its
logins arrive with
method: unknown. - Duplicates are possible after a timeout, because Binoban doesn't yet
de-duplicate by
event_id. - Low-traffic sites depend on WP-Cron unless a server cron job calls it.
- Single-page navigation sends the
pagecall only: the page event and the server attributes need a page WordPress rendered. - Attribute names must be Latin. A product attribute named in Persian is sent
as
attr_attribute_1; its values are sent as they are. - The trace live view reads the traced browser's log from the same origin, so the admin and the site must be on the same domain.