Migration Rest Portal

Build Apps

Go Headless

Client

API Preview

Develop Websites

REST

To use the Notifications API, install the `@wix/notifications` package using npm or Yarn:
  ```console
npm install @wix/notifications
```

or

```console
yarn add @wix/notifications
```

Then import `notifications` from `@wix/notifications`:

```js
import notifications from '@wix/notifications'
```
  

notifications

Sends a notification.


The `notify()` function sends a [notification](https://support.wix.com/en/article/about-your-dashboard-notifications) to the specified recipients on the specified channels.

List the the channels for the notification in the `channels` parameter .

List the recipients for the notification in the `toContacts`, `toSiteContributors`, and `toTopicsSubscribers` parameters.

notify

To use the Notifications API, install the `@wix/notifications` package using npm or Yarn:
  ```console
npm install @wix/notifications
```

or

```console
yarn add @wix/notifications
```

Then import `{ notifications }` from `@wix/notifications`:

```js
import { notifications } from '@wix/notifications'
```
  

Notifications

Channel

DashboardPages

NotifyOptions

URL of Dashboard page to navigate to when the `action` text is clicked.

targetDashboardPage

URL to navigate to when the `action` text is clicked.

targetUrl

toContacts

toSiteContributors

Notify contacts who are subscribed to specific topics.

toTopicsSubscribers

Clickable text that links to the `targetUrl` or `targetDashboardPage`. For example, "Click this!".

Max: 512 characters

action

string

Notification title. Only displayed on mobile and browser notifications.

Max: 512 characters

title

Role

ToContacts

contactIds

ToSiteContributors

Roles to receive the notification. One of:

- `"All_Contributors"`: All site contributors (default).
- `"Owner"`: Only the site owner.

Setup