For agencies and developers
White label, multisite, webhooks, the REST API and add-ons.
White label
Settings → Branding: set a Plugin Name to show instead of "Glimmer" in the admin menu, screens, product tab and Plugins list, and turn on Hide Glimmer branding to remove Glimmer's docs, support and upgrade links.
Multisite
Network-activate Glimmer, then open Network Admin → Glimmer:
- Network license — sites without a license activate with this key: new sites when they are created, existing sites when you tick Activate it on every site without a license now (or when an admin opens their dashboard). Each site uses one seat of the key's plan; staging and local sites are free.
- Default and locked settings — defaults are what new sites start with and fill in settings a site never saved. Lock a setting to use the network value on every site; site admins see a notice listing locked settings.
- Sites — every site's license status and plan.
Branding, CDN and customer-video settings stay per site.
Webhooks
Glimmer → Developers → Webhooks: add an endpoint URL and choose events.
Each delivery is signed (X-Glimmer-Signature: t=…,v1=…, HMAC-SHA256 with the
endpoint's secret) and retried on failure.
| Event | When |
|---|---|
video.updated | A product's video fields changed |
hotspots.updated | A product's hotspots changed |
video.optimized | A video optimization finished |
rules.updated | The video rules changed |
settings.updated | Glimmer's settings changed |
order.video_assisted | An order included products whose video was played |
ugc.submitted | A customer video is waiting for review |
ugc.approved | A customer video was approved |
REST API
Under /wp-json/glimmer/v1/, authenticated with an application password or a
REST nonce:
| Route | Use |
|---|---|
products, products/{id}/video | List products with videos; read and write a product's video fields, including extra_videos |
products/{id}/hotspots | Read and replace hotspots |
settings, rules | Read and change settings and video rules |
library | The Video Library index |
ugc, ugc/{id} | List and moderate customer videos |
analytics, webhooks | Analytics and webhook endpoints |
products/{id}/embed, products/{id}/ugc | Public: the embed config and approved customer videos |
Themes
Declare support with
add_theme_support( 'glimmer', [ 'gallery_selector' => '...', 'placement' => 'manual' ] )
and place the video with glimmer_the_product_video().
Add-ons
An add-on is a WordPress plugin that registers on glimmer_loaded:
The plugin's docs/SDK.md and docs/CONTRACT.md describe every hook, event,
REST route and the render contract.
