@_solaris/messenger-widget 0.4.9 → 0.4.11

package/README.md

@@ -56,12 +56,16 @@ import {
     userHash: '…',          // HMAC-SHA256(secret, userId), computed server-side
     displayMode: 'floating',// 'floating' | 'sheet' | 'embedded'
     language: 'en',         // optional — 'fr' | 'en'; else customer.language / widget.default_language
-    context: {              // optional — agent context
-      customer: {           //   pushed once to PATCH /customers/me
-        name:  'Jane Doe',  //   so the agent has it as context
+    // Optional agent context. `context.customer` is a flat object pushed
+    // once to PATCH /customers/me on boot so the agent has it as context.
+    // `name`/`email` map to the customer's columns; any other key is a
+    // named variable value (server keeps variables you don't pass):
+    context: {
+      customer: {
+        name:  'Jane Doe',
         email: 'jane@acme.io',
-        plan:  'pro',       //   any extra key → named variable (values)
-        seats: 12,          //   server keeps variables you don't pass
+        plan:  'pro',
+        seats: 12,
       },
     },
   });