> 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: collectionManagement

# Namespace: indexes

# Webhook link: https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/indexes/index-updated.md

## Introduction

Triggered when an index's status field is updated.

For example, during index creation, the index's status transitions from `BUILDING` to `ACTIVE` or `FAILED`. Either transition triggers this event.

---

## REST API

### Schema

```
Webhook: Index Updated
Description: Triggered when an index's status field is updated.  For example, during index creation, the index's status transitions from `BUILDING` to `ACTIVE` or `FAILED`. Either transition triggers this event.
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: Index | description: The entity after the update.
        - name: id | type: string | description: GUID of the index.
        - name: name | type: string | description: Name of the index.
        - name: fields | type: array<Field> | description: Fields for which the index is defined.  Max: 3 fields (for a unique index: 1 field)
           - name: path | type: string | description: Path of the field to index. For example: `title` or `options.price`.
           - name: order | type: Order | description: Sort order for the index. Base on how the data is regularly queried.  Default: `ASC`
               - enum: ASC, DESC
        - name: status | type: Status | description: Current status of the index.
           - enum:
           -     UNKNOWN: Place holder. Never returned by the service.
           -     BUILDING: Index creation is in progress.
           -     ACTIVE: Index has been successfully created and can be used in queries.
           -     DROPPING: Index is in the process of being dropped.
           -     DROPPED: Index has been dropped successfully.
           -     FAILED: Index creation has failed.
           -     INVALID: Index contains incorrectly indexed data.
        - name: failure | type: Failure | description: Contains details about the reasons for failure when `status` is `FAILED`.
           - name: code | type: string | description: Error code. - `WDE0112`: Unknown error while building collection index. - `WDE0113`: Duplicate key error while building collection index. - `WDE0114`: Document too large while building collection index.
           - name: description | type: string | description: Description of the failure.
           - name: itemId | type: string | description: GUID of the data item that caused the failure. For example, if `unique` is `true`, the GUID of an item containing a duplicate value.
        - name: unique | type: boolean | description: Whether the index enforces uniqueness of values in the field for which it's defined. If `true`, the index can have only 1 field.  Default: `false`
        - name: caseInsensitive | type: boolean | description: Whether the index ignores case.  Default: `false`
        - name: source | type: IndexSource | description: Source of the index. See index sources in [Index Types](https://dev.wix.com/docs/api-reference/business-solutions/cms/indexes/index-types.md#index-sources).  Default: `USER`
           - enum:
           -     SYSTEM: Automatically created by Wix for all collections.  System indexes are created for essential attributes, such as ID and creation date. You can't delete them and they don't count towards the index limit.
           -     USER: Created by a Wix user via the API or in the dashboard.
           -     AUTO: Created automatically by Wix based on a Wix user's queries.  For large collections, Wix identifies slow-running queries and creates indexes automatically to improve performance. These indexes don't count towards the index limit. They're created dynamically, and may be deleted if they no longer fit the system's parameters. To keep an automatic index permanently, manually create an identical `USER` index.

```

### Examples


```curl
{
  "id": "c91d8025-36e0-42ed-9953-888b7ecddcdc",
  "entityFqdn": "wix.data.v2.index",
  "slug": "updated",
  "entityId": "de7bc797-5d37-40a3-8d47-a0c060c38122",
  "updatedEvent": {
    "currentEntityAsJson": {
      "id": "de7bc797-5d37-40a3-8d47-a0c060c38122",
      "name": "Items Regular Index 1",
      "fields": [
        {
          "path": "title",
          "order": "ASC"
        }
      ],
      "status": "ACTIVE",
      "unique": false,
      "caseInsensitive": false,
      "source": "USER"
    }
  },
  "eventTime": "2025-09-05T11:39:47.389988575Z",
  "triggeredByAnonymizeRequest": false
}

```

---

## JavaScript SDK

### Schema

```
Webhook: onIndexUpdated
Description: Triggered when an index's status field is updated.  For example, during index creation, the index's status transitions from `BUILDING` to `ACTIVE` or `FAILED`. Either transition triggers this event.
Payload: IndexUpdatedEnvelope
  - name: entity | type: Index | description: none
     - name: _id | type: string | description: GUID of the index.
     - name: name | type: string | description: Name of the index.
     - name: fields | type: array<Field> | description: Fields for which the index is defined.  Max: 3 fields (for a unique index: 1 field)
        - name: path | type: string | description: Path of the field to index. For example: `title` or `options.price`.
        - name: order | type: Order | description: Sort order for the index. Base on how the data is regularly queried.  Default: `ASC`
             - enum: ASC, DESC
     - name: status | type: Status | description: Current status of the index.
         - enum:
         -     UNKNOWN: Place holder. Never returned by the service.
         -     BUILDING: Index creation is in progress.
         -     ACTIVE: Index has been successfully created and can be used in queries.
         -     DROPPING: Index is in the process of being dropped.
         -     DROPPED: Index has been dropped successfully.
         -     FAILED: Index creation has failed.
         -     INVALID: Index contains incorrectly indexed data.
     - name: failure | type: Failure | description: Contains details about the reasons for failure when `status` is `FAILED`.
        - name: code | type: string | description: Error code. - `WDE0112`: Unknown error while building collection index. - `WDE0113`: Duplicate key error while building collection index. - `WDE0114`: Document too large while building collection index.
        - name: description | type: string | description: Description of the failure.
        - name: itemId | type: string | description: GUID of the data item that caused the failure. For example, if `unique` is `true`, the GUID of an item containing a duplicate value.
     - name: unique | type: boolean | description: Whether the index enforces uniqueness of values in the field for which it's defined. If `true`, the index can have only 1 field.  Default: `false`
     - name: caseInsensitive | type: boolean | description: Whether the index ignores case.  Default: `false`
     - name: source | type: IndexSource | description: Source of the index. See index sources in [Index Types](https://dev.wix.com/docs/api-reference/business-solutions/cms/indexes/index-types.md#index-sources).  Default: `USER`
         - enum:
         -     SYSTEM: Automatically created by Wix for all collections.  System indexes are created for essential attributes, such as ID and creation date. You can't delete them and they don't count towards the index limit.
         -     USER: Created by a Wix user via the API or in the dashboard.
         -     AUTO: Created automatically by Wix based on a Wix user's queries.  For large collections, Wix identifies slow-running queries and creates indexes automatically to improve performance. These indexes don't count towards the index limit. They're created dynamically, and may be deleted if they no longer fit the system's parameters. To keep an automatic index permanently, manually create an identical `USER` index.
  - 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 { indexes } from '@wix/data';

indexes.onIndexUpdated((event) => {
    // handle your event here
});
```


```javascript
import { createClient, AppStrategy } from '@wix/sdk';
import { indexes } from '@wix/data';

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

wixClient.indexes.onIndexUpdated((event) => {
    // handle your event here
});
```

---