Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add email verification docs #146

Merged
merged 2 commits into from
Dec 3, 2024
Merged

Add email verification docs #146

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c584ae
Add email verification docs
DLeyland Dec 3, 2024
85f0d5a
Mention emailHash
DLeyland Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions chat/authentication.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,20 @@ Plain.init({
},
});
```

## Customer verification

If you want to see the name and email of customers who get in touch via chat you can require them to provide their details
by setting `requireAuthentication` to true in Plain init:

```typescript
Plain.init({
requireAuthentication: true
});
```

When enabled, any customer getting in touch will first be presented with a form allowing them to enter their name and email address.

The customer will then receive a verification code to that email which they can enter to start a chat.

If an `emailHash` is already set in `customerDetails`, then the verification screen will not appear since the customer has already been authenticated.
Loading