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

# Namespace: consentConfigs

# Webhook link: https://dev.wix.com/docs/api-reference/business-management/cookie-consent-policy/consent-configs/consent-config-updated.md

## Introduction

Triggered when a consent config is updated.

---

## REST API

### Schema

```
Webhook: Consent Config Updated
Description: Triggered when a consent config 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: ConsentConfig | description: The entity after the update.
        - ONE-OF:
           - name: tagDetails | type: AppDetails | description: Details about the app that owns the embed.
              - name: appId | type: string | description: App GUID.
              - name: componentId | type: string | description: App component GUID.
              - name: version | type: string | description: App version.
           - name: cookieDetails | type: CookieDetails | description: Cookie details. Not supported yet.
              - name: name | type: string | description: Cookie name.
              - name: description | type: string | description: Cookie description.
        - name: id | type: string | description: Consent config GUID.
        - name: revision | type: string | description: Revision number, which increments by 1 each time the consent config is updated. To prevent conflicting changes, the current revision must be passed when updating the consent config.  Ignored when creating a consent config.
        - name: createdDate | type: string | description: Date and time the consent config was created.
        - name: updatedDate | type: string | description: Date and time the consent config was last updated.
        - name: configType | type: ConfigType | description: Type of consent config. Currently only the `TAG_OVERRIDE` type is supported.
           - enum:
           -     UNKNOWN_CONFIG: Unknown config type.
           -     TAG_OVERRIDE: Overrides the app embed's category.
        - name: consentCategory | type: ConsentCategory | description: The consent config's categories for compliance with privacy regulations.
           - enum:
           -     UNKNOWN_CATEGORY: 
           -     essential: Includes core functionality such as security, verification of identity and network management. These cookies can’t be disabled.
           -     functional: Includes collecting data to remember choices users make to improve and give a more personalised experience.
           -     analytics: Includes tracking visitor interactions with a site, to discover errors and provide better overall analytics.
           -     advertising: Includes tracking advertising effectiveness to provide a more relevant service and deliver better ads to suit visitors' interests.
           -     data_to_third_party: Includes collecting data to pass on to a third party.
        - name: createdBy | type: CreatedBy | description: Consent config creator.
           - name: userId | type: string | description: User GUID.
           - name: appId | type: string | description: App GUID.
        - name: extendedFields | type: ExtendedFields | description: Custom field data for the consent config. Extended fields must be configured in the app dashboard before they can be accessed with API calls.
           - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md).
        - name: tags | type: Tags | description: Consent config tags, meaning labels for administrative purposes.
           - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors.
              - name: tagIds | type: array | description: List of tag GUIDs
           - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors.

```

### Examples


```curl
{
  "id": "52269077-05f2-4b59-ba4f-36ef8c4c1e11",
  "entityFqdn": "wix.bu.legal.v1.consent_config",
  "slug": "updated",
  "entityId": "334afbf6-5c8b-4b43-9e9e-dd28664ca28f",
  "updatedEvent": {
    "currentEntityAsJson": "{\"consentConfig\":{\"id\": \"334afbf6-5c8b-4b43-9e9e-dd28664ca28f\",\"revision\": \"1\",\"createdDate\": \"2025-03-04T07:58:24.131Z\",\"updatedDate\": \"2025-03-04T07:58:24.131Z\",\"configType\": \"TAG_OVERRIDE\",\"consentCategory\": \"essential\",\"tagDetails\": {\"appId\": \"73bc078f-b2d7-4ee7-a6e6-41b28ec661d9\",\"componentId\": \"c7afb240-4cbb-4bbb-adeb-936818698cc9\",\"version\": \"^1.0.0\"}}}"
  },
  "eventTime": "2020-10-18T13:40:58.304800Z",
  "triggeredByAnonymizeRequest": false
}

```

---

## JavaScript SDK

### Schema

```
Webhook: onConsentConfigUpdated
Description: Triggered when a consent config is updated.
Payload: ConsentConfigUpdatedEnvelope
  - name: entity | type: ConsentConfig | description: none
     - ONE-OF:
        - name: tagDetails | type: AppDetails | description: Details about the app that owns the embed.
           - name: appId | type: string | description: App GUID.
           - name: componentId | type: string | description: App component GUID.
           - name: version | type: string | description: App version.
        - name: cookieDetails | type: CookieDetails | description: Cookie details. Not supported yet.
           - name: name | type: string | description: Cookie name.
           - name: description | type: string | description: Cookie description.
     - name: _id | type: string | description: Consent config GUID.
     - name: revision | type: string | description: Revision number, which increments by 1 each time the consent config is updated. To prevent conflicting changes, the current revision must be passed when updating the consent config.  Ignored when creating a consent config.
     - name: _createdDate | type: Date | description: Date and time the consent config was created.
     - name: _updatedDate | type: Date | description: Date and time the consent config was last updated.
     - name: configType | type: ConfigType | description: Type of consent config. Currently only the `TAG_OVERRIDE` type is supported.
         - enum:
         -     UNKNOWN_CONFIG: Unknown config type.
         -     TAG_OVERRIDE: Overrides the app embed's category.
     - name: consentCategory | type: ConsentCategory | description: The consent config's categories for compliance with privacy regulations.
         - enum:
         -     UNKNOWN_CATEGORY: 
         -     essential: Includes core functionality such as security, verification of identity and network management. These cookies can’t be disabled.
         -     functional: Includes collecting data to remember choices users make to improve and give a more personalised experience.
         -     analytics: Includes tracking visitor interactions with a site, to discover errors and provide better overall analytics.
         -     advertising: Includes tracking advertising effectiveness to provide a more relevant service and deliver better ads to suit visitors' interests.
         -     data_to_third_party: Includes collecting data to pass on to a third party.
     - name: createdBy | type: CreatedBy | description: Consent config creator.
        - name: userId | type: string | description: User GUID.
        - name: appId | type: string | description: App GUID.
     - name: extendedFields | type: ExtendedFields | description: Custom field data for the consent config. Extended fields must be configured in the app dashboard before they can be accessed with API calls.
        - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md).
     - name: tags | type: Tags | description: Consent config tags, meaning labels for administrative purposes.
        - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors.
           - name: tagIds | type: array | description: List of tag GUIDs
        - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors.
  - 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 { consentConfig } from '@wix/consent-policy';

consentConfig.onConsentConfigUpdated((event) => {
    // handle your event here
});
```


```javascript
import { createClient, AppStrategy } from '@wix/sdk';
import { consentConfig } from '@wix/consent-policy';

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

wixClient.consentConfig.onConsentConfigUpdated((event) => {
    // handle your event here
});
```

---