> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# Package: dashboard

# Namespace: dashboardFavoriteList

# Webhook link: https://dev.wix.com/docs/api-reference/business-management/dashboard/dashboard-favorite-list/favorite-list-updated.md

## Introduction

Triggered when pages are added, removed, or the dashboard favorite list is updated.

---

## REST API

### Schema

```
Webhook: Favorite List Updated
Description: Triggered when pages are added, removed, or the dashboard favorite list is updated.
Event body:
 - name: id | type: string | description: Unique event ID. Allows clients to ignore duplicate events.
 - name: entityFqdn | type: string | description: Fully qualified domain name of the entity associated with the event.
 - name: slug | type: string | description: Event name.
 - name: entityId | type: string | description: ID of the entity associated with the event.
 - name: eventTime | type: string (date-time) | description: Event timestamp.
 - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application such as GDPR.
 - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
 - name: updatedEvent | type: object | description: Updated event details.
    - name: currentEntity | type: DashboardFavoriteList | description: The entity after the update.
        - name: id | type: string | description: Dashboard favorite list GUID. Automatically generated by Wix.
        - name: revision | type: string | description: Revision number. Increments automatically by 1 whenever the list is successfully updated. To prevent conflicting changes, pass the current revision number when updating the list.
        - name: createdDate | type: string | description: Date and time the dashboard favorite list was created.
        - name: updatedDate | type: string | description: Date and time the dashboard favorite list was last updated.
        - name: favorites | type: array<Favorite> | description: List of favorite dashboard pages.
           - name: id | type: string | description: Favorite GUID. Automatically generated by Wix.
           - name: pageId | type: string | description: GUID of the page added to the list.
           - name: relativeUrl | type: string | description: Relative URL appended to the page's URL for customizing the navigation. It can include path segments, a query string, or a fragment identifier.
           - name: title | type: string | description: Custom title displayed in the list of favorite pages.

```

### Examples


```curl
{
  "id": "3f53095f-d6ba-455c-b907-2bee6f1389f9",
  "entityFqdn": "wix.os.backoffice.v1.favorites",
  "slug": "updated",
  "entityId": "67214477-f886-4583-a4cc-60495f5e2e78",
  "updatedEvent": {
    "currentEntity": {
      "id": "67214477-f886-4583-a4cc-60495f5e2e78",
      "revision": "5",
      "createdDate": "2024-05-21T16:38:23.355Z",
      "updatedDate": "2024-05-21T16:53:40.493Z",
      "favorites": [
        {
          "id": "5332fd97-e2dd-4eb2-b59e-c0f84c1c9895",
          "pageId": "5077a343-8f35-46b7-9942-d7a526555eb0",
          "title": "Updated First Favorite"
        },
        {
          "id": "96dc7876-0203-47a6-9654-45a30dbc65cd",
          "pageId": "dd0f5103-00ac-4303-827f-f08b4de2f163",
          "title": "Second Favorite"
        }
      ]
    }
  },
  "eventTime": "2024-05-21T16:53:40.612668746Z",
  "triggeredByAnonymizeRequest": false,
  "entityEventSequence": "5"
}

```

---

## JavaScript SDK

### Schema

```
Webhook: onFavoriteListUpdated
Description: Triggered when pages are added, removed, or the dashboard favorite list is updated.
Payload: FavoriteListUpdatedEnvelope
  - name: entity | type: DashboardFavoriteList | description: none
     - name: _id | type: string | description: Dashboard favorite list GUID. Automatically generated by Wix.
     - name: revision | type: string | description: Revision number. Increments automatically by 1 whenever the list is successfully updated. To prevent conflicting changes, pass the current revision number when updating the list.
     - name: _createdDate | type: Date | description: Date and time the dashboard favorite list was created.
     - name: _updatedDate | type: Date | description: Date and time the dashboard favorite list was last updated.
     - name: favorites | type: array<Favorite> | description: List of favorite dashboard pages.
        - name: _id | type: string | description: Favorite GUID. Automatically generated by Wix.
        - name: pageId | type: string | description: GUID of the page added to the list.
        - name: relativeUrl | type: string | description: Relative URL appended to the page's URL for customizing the navigation. It can include path segments, a query string, or a fragment identifier.
        - name: title | type: string | description: Custom title displayed in the list of favorite pages.
  - name: metadata | type: EventMetadata | description: none
     - name: instanceId | type: string | description: App instance GUID.
     - name: eventType | type: string | description: Event type.
     - name: identity | type: IdentificationData | description: The identification type and identity data.
        - ONE-OF:
           - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site.
           - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site.
           - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.).
           - name: appId | type: string | description: GUID of an app.
        - name: identityType | type: WebhookIdentityType | description: 
             - enum: UNKNOWN, ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
     - name: accountInfo | type: AccountInfo | description: Details related to the account
        - name: accountId | type: string | description: GUID of the Wix account associated with the event.
        - name: parentAccountId | type: string | description: GUID of the parent Wix account. Only included when accountId belongs to a child account.
        - name: siteId | type: string | description: GUID of the Wix site associated with the event. Only included when the event is tied to a specific site.
     - name: _id | type: string | description: Event GUID. With this GUID you can easily spot duplicated events and ignore them.
     - name: entityFqdn | type: string | description: Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
     - name: slug | type: string | description: Event action name, placed at the top level to make it easier for users to dispatch messages. For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
     - name: entityId | type: string | description: GUID of the entity associated with the event.
     - name: eventTime | type: Date | description: Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`.
     - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
     - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
     - name: entityEventSequence | type: string | description: A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number. You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.

```

### Examples


```javascript
import { favoriteList } from '@wix/dashboard-management';

favoriteList.onFavoriteListUpdated((event) => {
    // handle your event here
});
```


```javascript
import { createClient, AppStrategy } from '@wix/sdk';
import { favoriteList } from '@wix/dashboard-management';

const wixClient = createClient({
  auth: AppStrategy({
    appId: 'MY-APP-ID',
    publicKey: 'YOUR_APP_PUBLIC_KEY',
  }),
  modules: {
      favoriteList,
    },
});

wixClient.favoriteList.onFavoriteListUpdated((event) => {
    // handle your event here
});
```

---