Update identify-web-user.mdx #188

Atul-Butola · 2025-04-02T08:52:56Z

no-work-item

github-actions · 2025-04-02T08:53:49Z

🌟 EkLine Reviewer

Hello! I’m here to help improve your docs. I’ve reviewed your pull request, and left in-line suggestions for quick fixes. For details, visit the Analytics Page.

For questions or feedback, please email [email protected].

github-actions · 2025-04-02T08:54:44Z

Published docs preview URL: https://devrev-preview-270970c9-64c9-4c14-9285-ddb9c44bb9f3.docs.buildwithfern.com

bc-devrev · 2025-04-02T15:52:08Z

fern/docs/pages/plug-sdk/identify-web-user.mdx

@@ -102,7 +102,7 @@ If you prefer a two-level structure, where users are directly associated with an
 |`account_ref`   |A unique reference for the account.    |string   |
 |`display_name`    | The name of the account that's shown on the widget.    |string   |
 |`domains`   |The domain names of the accounts that the users belongs to.   |array   |
-| `phone_numbers`    |The phone number associated with the account.   |array   |
+|`phone_numbers`    |The phone number associated with the account must be in E.164 format.   |array   |


sambhavjain9138 · 2025-04-08T06:39:28Z

fern/docs/pages/plug-sdk/identify-web-user.mdx

+| Attributes    | Description                                                                 | Type   | Required | Unique |
+|---------------|-----------------------------------------------------------------------------|--------|----------|--------|
+| user_ref      | A unique user reference that the DevRev app uses for identifying your users. This parameter is required. | string | ✅       | Yes    |
+| email         | The email address of the customer. It's used for sending email notifications of any support messages. | string | ❌       | No     |


For Email, by default we would mark emails as unique but if organizations want, they can choose to update it to non unique. Can we put
Unique as true with **.

where ** is Unless organizations explicitly mark emails as non unique via preferences. Basically organizations can update the uniqueness check on email. So whatever message seems fine

github-actions · 2025-04-08T06:47:50Z

Published docs preview URL: https://devrev-preview-e142812e-1b6b-4321-9c86-77fed3e83008.docs.buildwithfern.com

github-actions · 2025-04-08T06:51:49Z

Published docs preview URL: https://devrev-preview-25968cde-d85e-4a5d-ba72-940fd59a59cb.docs.buildwithfern.com

github-actions · 2025-04-10T06:18:27Z

Published docs preview URL: https://devrev-preview-51717e52-d810-495a-a058-83d3ee93a084.docs.buildwithfern.com

github-actions · 2025-04-10T14:34:59Z

Published docs preview URL: https://devrev-preview-4c40b426-9f4f-45c5-b18f-592b0ebfc041.docs.buildwithfern.com

github-actions · 2025-04-10T14:45:55Z

fern/docs/pages/plug-sdk/web/user-identity.mdx

⚠️ [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/plug-sdk/web/user-identity.mdx

Line 13 in 9c7bac5

Ensure you copy your access token, as you will not be able to view it again.

github-actions · 2025-04-10T14:46:29Z

Published docs preview URL: https://devrev-preview-82455c2a-25ea-4c4f-b14d-87e84b60bf4b.docs.buildwithfern.com

…o Plug-info

github-actions · 2025-04-10T14:59:17Z

Published docs preview URL: https://devrev-preview-ebb2a6aa-0f08-41ee-bcf1-c5f9befc5178.docs.buildwithfern.com

bc-devrev

The suggestions are mostly superficial but please address them before merging.

bc-devrev · 2025-04-10T15:58:26Z

fern/docs/pages/plug-sdk/web/user-identity.mdx

+- Populate user traits like email and display name to:
+    - Make users identifiable
+    - Prevent duplicate users across integrations


Better to have these inline.

Suggested change

- Populate user traits like email and display name to:

- Make users identifiable

- Prevent duplicate users across integrations

- Populate user traits like email and display name to make users identifiable and to prevent duplicate users across integrations.

bc-devrev · 2025-04-10T15:58:55Z

fern/docs/pages/plug-sdk/web/user-identity.mdx

+- Maintain consistent unique identifiers across your system
+- Follow the specified formats for phone numbers and domains
+- Keep your application access token secure


These items should end with a period.

Suggested change

- Maintain consistent unique identifiers across your system

- Follow the specified formats for phone numbers and domains

- Keep your application access token secure

- Maintain consistent unique identifiers across your system.

- Follow the specified formats for phone numbers and domains.

- Keep your application access token secure.

bc-devrev · 2025-04-10T15:59:37Z

fern/docs/pages/plug-sdk/web/user-identity.mdx

+   - What to include: User, workspace and account information
+   - Only use workspace information if your business model requires workspace organization
+
+In a DevOrg, unique identifiers are utilized to handle objects. If an object doesn't exist, it is created and then an attempt is made to link it. For example, here's how it operates:


Suggested change

In a DevOrg, unique identifiers are utilized to handle objects. If an object doesn't exist, it is created and then an attempt is made to link it. For example, here's how it operates:

In a dev org, unique identifiers are utilized to handle objects. If an object doesn't exist, it is created and then an attempt is made to link it. For example, here's how it operates:

bc-devrev · 2025-04-10T15:59:58Z

fern/docs/pages/plug-sdk/web/user-identity.mdx

+
+DevRev offers three ways to structure your customer's data:
+1. **Single-level (Recommended for most B2C cases)**
+   - User


Not sure what this means.

bc-devrev · 2025-04-10T16:00:51Z

fern/docs/pages/plug-sdk/web/user-identity.mdx

+### How resolution works
+
+DevRev offers three ways to structure your customer's data:
+1. **Single-level (Recommended for most B2C cases)**


This list would probably be better as a table with columns number of levels, use case, user relationship, and required information.

bc-devrev · 2025-04-10T16:01:31Z

fern/docs/pages/plug-sdk/web/user-identity.mdx

-If you prefer a two-level structure, where users are directly associated with an account instead of a workspace, you can provide the `user_ref` and details along with the `account_ref` and details.
+### API status codes and troubleshooting
+
+| Status code| Description & Troubleshooting |


bc-devrev · 2025-04-10T16:02:04Z

fern/docs/pages/plug-sdk/web/user-identity.mdx

+|-----------------|-------------------------------------------------------------------------------------------------------------------|--------|----------|--------|
+| `account_ref`   | A unique reference for the account.                                                                               | string | ❌        | ✅      |
+| `display_name`  | The name of the account that's shown on the widget.                                                               | string | ❌        | ✅     |
+| `domains`       | Use a unique format like 'devrev.ai'. Formats such as 'https://devrev.ai' or 'www.devrev.ai' are not valid.       | array  | ❌        | ✅     |


bc-devrev · 2025-04-10T16:03:09Z

fern/docs/pages/plug-sdk/web/user-identity.mdx

+| user_ref      | A unique user reference that the DevRev app uses for identifying your users. This parameter is required. | string | ✅       | ✅    |
+| email         | The email address of the customer. It's used for sending email notifications of any support messages. | string | ❌       | ✅**     |
+| display_name  | The name of the user that's shown on the widget.                          | string | ❌*       | ❌     |
+| phone_numbers | The customer's mobile number, which must adhere to the E.164 format.       | array  | ❌      | ❌     |


bc-devrev · 2025-04-10T16:03:41Z

fern/docs/pages/plug-sdk/web/user-identity.mdx

@@ -18,7 +16,7 @@ Ensure you copy your access token, as you will not be able to view it again.
 ## Generate a session token

 <Callout intent="note">
-For security reasons, this call should be made from the server side so that your AAT isn't exposed.
+For security reasons, this API call must be made from your server side to prevent exposing your Application Access Token (AAT).


Suggested change

For security reasons, this API call must be made from your server side to prevent exposing your Application Access Token (AAT).

For security reasons, this API call must be made from the server side to prevent exposing your application access token (AAT).

Update identify-web-user.mdx

8380d25

no-work-item

Atul-Butola requested a review from a team as a code owner April 2, 2025 08:52

Atul-Butola marked this pull request as draft April 2, 2025 08:53

bc-devrev approved these changes Apr 2, 2025

View reviewed changes

Atul-Butola added 2 commits April 8, 2025 11:00

Update identify-web-user.mdx

1cc90b3

Update identify-web-user.mdx

8cc62a7

Atul-Butola marked this pull request as ready for review April 8, 2025 05:48

Atul-Butola added 2 commits April 8, 2025 11:26

Update identify-web-user.mdx

6132d27

Update identify-web-user.mdx

906f16e

sambhavjain9138 reviewed Apr 8, 2025

View reviewed changes

Merge branch 'main' into Plug-info

7d1aae9

Update user-identity.mdx

e5ddb8a

Atul-Butola changed the title **WIP** Update identify-web-user.mdx Update identify-web-user.mdx Apr 8, 2025

Update user-identity.mdx

d3ba331

sambhavjain9138 added 2 commits April 10, 2025 19:20

update documentation

11f2846

final changes

e9d872d

Merge branch 'main' into Plug-info

9c7bac5

github-actions bot reviewed Apr 10, 2025

View reviewed changes

sambhavjain9138 added 3 commits April 10, 2025 20:21

nit

7f910f5

Merge branch 'Plug-info' of ssh://github.com/devrev/fern-api-docs int…

ffee3fe

…o Plug-info

nit

c4e69ec

bc-devrev reviewed Apr 10, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update identify-web-user.mdx #188

Update identify-web-user.mdx #188

Atul-Butola commented Apr 2, 2025

github-actions bot commented Apr 2, 2025 •

edited

Loading

github-actions bot commented Apr 2, 2025

bc-devrev Apr 2, 2025

sambhavjain9138 Apr 8, 2025

github-actions bot commented Apr 8, 2025

github-actions bot commented Apr 8, 2025

github-actions bot commented Apr 10, 2025

github-actions bot commented Apr 10, 2025

github-actions bot Apr 10, 2025

github-actions bot commented Apr 10, 2025

github-actions bot commented Apr 10, 2025

bc-devrev left a comment

bc-devrev Apr 10, 2025

bc-devrev Apr 10, 2025

bc-devrev Apr 10, 2025

bc-devrev Apr 10, 2025

bc-devrev Apr 10, 2025

bc-devrev Apr 10, 2025

bc-devrev Apr 10, 2025

bc-devrev Apr 10, 2025

bc-devrev Apr 10, 2025

	\|`phone_numbers` \|The phone number associated with the account must be in E.164 format. \|array \|
	\|`phone_numbers` \|The phone number associated with the account in E.164 format. \|array \|

	In a DevOrg, unique identifiers are utilized to handle objects. If an object doesn't exist, it is created and then an attempt is made to link it. For example, here's how it operates:
	In a dev org, unique identifiers are utilized to handle objects. If an object doesn't exist, it is created and then an attempt is made to link it. For example, here's how it operates:

	\| Status code\| Description & Troubleshooting \|
	\| Status code\| Description \| Troubleshooting \|

	\| `domains` \| Use a unique format like 'devrev.ai'. Formats such as 'https://devrev.ai' or 'www.devrev.ai' are not valid. \| array \| ❌ \| ✅ \|
	\| `domains` \| Use a format like `devrev.ai`. Formats such as `https://devrev.ai` or `www.devrev.ai` are not valid. \| array \| ❌ \| ✅ \|

	For security reasons, this API call must be made from your server side to prevent exposing your Application Access Token (AAT).
	For security reasons, this API call must be made from the server side to prevent exposing your application access token (AAT).

Update identify-web-user.mdx #188

Are you sure you want to change the base?

Update identify-web-user.mdx #188

Conversation

Atul-Butola commented Apr 2, 2025

github-actions bot commented Apr 2, 2025 • edited Loading

🌟 EkLine Reviewer

github-actions bot commented Apr 2, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Apr 8, 2025

github-actions bot commented Apr 8, 2025

github-actions bot commented Apr 10, 2025

github-actions bot commented Apr 10, 2025

github-actions bot Apr 10, 2025

Choose a reason for hiding this comment

github-actions bot commented Apr 10, 2025

github-actions bot commented Apr 10, 2025

bc-devrev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Apr 2, 2025 •

edited

Loading