Skip to content

Commit

Permalink
Merge pull request novuhq#564 from pgaijin66/update-docs
Browse files Browse the repository at this point in the history
Updated documentation. Using gender neutral language and making doc mo…
  • Loading branch information
ainouzgali authored May 16, 2022
2 parents f7add94 + 823ed8d commit 24c1327
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/docs/notification-center/react-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ function CustomNotificationCenter() {

## HMAC Encryption

When Novu's user adds the notification center to his application he is required to pass a `subscriberId` which identifies the user's end-customer, and the application Identifier which is acted as a public key to communicate with the notification feed API.
When Novu's user adds the notification center to their application they are required to pass a `subscriberId` which identifies the user's end-customer, and the application Identifier which is acted as a public key to communicate with the notification feed API.

A malicious actor can access the user feed by accessing the API and passing another `subscriberId` using the public application identifier.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/platform/activity-feed.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This can be used to monitor activity and discover potential issues with a specif

## Viewing a specific subscriber activity

To use a subscriber activity feed you can filter the feed by using the subscriberId or his email. This will show only the relevant data for this particular subscriber.
To use a subscriber activity feed you can filter the feed by using the subscriberId or email. This will show only the relevant data for this particular subscriber.

You can hover over the status icon to get additional information in case there was an error during delivery.

Expand Down
8 changes: 4 additions & 4 deletions docs/docs/platform/subscribers.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A novu subscribers contains the following data points:
- **Contact information** - Things like e-mail, phone number, push tokens and etc... They will be used when a multi-channel template will be configured. Managing all communication credentials will reduce the amount of data you need to pass when triggering a notification.

## Creating a subscriber
When you want to send a notification to a specific recipient in the Novu platform, you must first create him with our server SDK.
When you want to send a notification to a specific recipient in the Novu platform, you must first create a subscriber using our server SDK.

```typescript
import { Novu } from '@novu/node'
Expand All @@ -29,10 +29,10 @@ await novu.subscribers.identify(user.id, {
Novu will create a subscriber if one does not exist, and will update existing subscribers based on the identify payload. You can call this function during registration or signup to make sure the subscriber data is up to date.
### Subscriber identifier
This is a unique identifier used by Novu to keep track of a specific subscriber. We recommend using the internal id you application uses for a specific users.
Using an identifier like email might cause issues locating a specific subscriber once he changes his mail address.
Using an identifier like email might cause issues locating a specific subscriber once they change their email address.

### Updating subscriber data
In some cases you want to access subscribers to update a specific field or data attribute. For example when a user changes his email address or personal details.
In some cases you want to access subscribers to update a specific field or data attribute. For example when user changes their email address or personal details.

```typescript
import { Novu } from '@novu/node'
Expand All @@ -45,7 +45,7 @@ await novu.subscribers.update(user.id, {
```

### Removing a subscriber
To remove a subscriber and stop him from receiving communication, you call the remove API to delete the subscriber.
To remove and stop a subscriber from receiving communication, you call the remove API to delete the subscriber.

```typescript
import { Novu } from '@novu/node'
Expand Down

0 comments on commit 24c1327

Please sign in to comment.