guidewhale 1.0.13 → 1.0.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -34,15 +34,17 @@ let userSignature = crypto
|
|
|
34
34
|
Start by importing our package by calling `import gwhale from 'guidewhale'`, then initialize the environment and currently active user/company.
|
|
35
35
|
Make sure to replace placeholder values with your actual environment token and user/company properties, while removing any non-required properties which you don't have/need.
|
|
36
36
|
|
|
37
|
+
> ⚠️ **Warning:** Do not name your custom properties with a leading underscore (`_`), as they are reserved for internally generated properties.
|
|
38
|
+
|
|
37
39
|
```typescript
|
|
38
40
|
import gwhale from 'guidewhale';
|
|
39
41
|
|
|
40
42
|
gwhale.init("<guidewhale_environment_code>", { // REQUIRED - string - make sure to use the correct environment code for desired application environment (e.g. 'prod-1234abcd')
|
|
41
43
|
gdpr: true, // OPTIONAL - true | false - enable GDPR mode to require user consent before tracking data under their user_id
|
|
42
44
|
gdpr_consent: true, // OPTIONAL - true | false - Whether user has given consent to track their data
|
|
45
|
+
signature: <user_signature>, // REQUIRED IF USER_ID IS SET - string - user signature hash (not the secret!) to prevent unathorized initialization
|
|
43
46
|
user: {
|
|
44
47
|
user_id: <user_id>, // REQUIRED - string | null - unique user identifier (e.g. null for anonymous users, '100000356', '6099047b-660b-4f2e-a878-fb66a12c1840', 'john.smith@example.com')
|
|
45
|
-
signature: <user_signature>, // REQUIRED IF USER_ID IS SET - string - user signature hash (not the secret!) to prevent unathorized initialization
|
|
46
48
|
email: <user_email>, // RECOMMENDED - string - email is used as the key to map user data for most integrations (e.g. 'john.smith@example.com')
|
|
47
49
|
image_url: <profile_image_url>, // RECOMMENDED - string - used to display user's profile image inside GuideWhale dashboard (e.g. 'https://cdn.guidewhale.com/users/1234abcd/profile.png')
|
|
48
50
|
first_name: <user_first_name>, // RECOMMENDED - string - can be used to personalize GuideWhale content (e.g. 'John')
|