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

# Webhook link: https://dev.wix.com/docs/api-reference/business-management/custom-embeds/custom-embed-updated.md

## Introduction

Triggered when a custom embed is updated.

---

## REST API

### Schema

```
Webhook: Custom Embed Updated
Description: Triggered when a custom embed 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: CustomEmbed | description: The entity after the update.
        - name: id | type: string | description: Custom embed GUID.
        - name: revision | type: string | description: Revision number, which increments by 1 each time the custom embed is updated. To prevent conflicting changes, the current revision must be passed when updating a custom embed.
        - name: name | type: string | description: Custom embed name, as displayed to Wix users.
        - name: enabled | type: boolean | description: Whether the custom embed is enabled on the site. Default: `true`.
        - name: loadOnce | type: boolean | description: Whether to load the custom embed once during initial site rendering, rather than on each page navigation. This setting affects performance and should be chosen based on the embed's functionality. Default: `true`.
        - name: domain | type: string | description: Site domain that's connected to the site, if relevant.
        - name: position | type: PositionOnPage | description: Position where the custom embed code is placed on the page.
           - enum:
           -     UNKNOWN_POSITION: Illegal value, exception will be thrown if used
           -     HEAD: HEAD position
           -     BODY_START: BODY_START position
           -     BODY_END: BODY_END position
        - name: embedData | type: CustomEmbed | description: Custom embed data.
           - name: category | type: Category | description: CustomEmbed's category
               - enum:
               -     UNKNOWN_CATEGORY: Illegal type, exception will be thrown if used
               -     ESSENTIAL: Essential category
               -     FUNCTIONAL: Functional category
               -     ANALYTICS: Analytics category
               -     ADVERTISING: Advertising category
               -     DATA_TO_THIRD_PARTY: Data to third party category
           - name: html | type: string | description: CustomEmbed's html
        - name: pageFilter | type: PageFilter | description: Page GUIDs where the custom embed should be loaded. By default, custom embeds are applied to all site pages.
           - name: pageIds | type: array | description: Pages where the site embed will be loaded.

```

### Examples


```curl
{
  "id": "52269077-05f2-4b59-ba4f-36ef8c4c1e11",
  "entityFqdn": "wix.embeds.v1.custom_embed",
  "slug": "updated",
  "entityId": "8046df3c-7575-4098-a5ab-c91ad8f33c47",
  "updatedEvent": {
    "currentEntityAsJson": "{\"customEmbed\":{\"id\":\"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\"revision\":\"2\",\"name\":\"Updated Custom Embed\",\"enabled\":true,\"loadOnce\":true,\"domain\":\"myDomain.com\",\"position\":\"BODY_END\",\"embedData\":{\"category\":\"ANALYTICS\",\"html\":\"<script>console.log(\\\"Updated code\\\")</script>\"}}}"
  },
  "eventTime": "2023-10-18T13:40:58.304800Z",
  "triggeredByAnonymizeRequest": false,
  "entityEventSequence":"12"
}
```

---

## JavaScript SDK

### Schema

```
Webhook: onCustomEmbedUpdated
Description: Triggered when a custom embed is updated.
Payload: CustomEmbedUpdatedEnvelope
  - name: entity | type: CustomEmbed | description: none
     - name: _id | type: string | description: Custom embed GUID.
     - name: revision | type: string | description: Revision number, which increments by 1 each time the custom embed is updated. To prevent conflicting changes, the current revision must be passed when updating a custom embed.
     - name: name | type: string | description: Custom embed name, as displayed to Wix users.
     - name: enabled | type: boolean | description: Whether the custom embed is enabled on the site. Default: `true`.
     - name: loadOnce | type: boolean | description: Whether to load the custom embed once during initial site rendering, rather than on each page navigation. This setting affects performance and should be chosen based on the embed's functionality. Default: `true`.
     - name: domain | type: string | description: Site domain that's connected to the site, if relevant.
     - name: position | type: PositionOnPage | description: Position where the custom embed code is placed on the page.
         - enum:
         -     UNKNOWN_POSITION: Illegal value, exception will be thrown if used
         -     HEAD: HEAD position
         -     BODY_START: BODY_START position
         -     BODY_END: BODY_END position
     - name: embedData | type: CustomEmbed | description: Custom embed data.
        - name: category | type: Category | description: CustomEmbed's category
             - enum:
             -     UNKNOWN_CATEGORY: Illegal type, exception will be thrown if used
             -     ESSENTIAL: Essential category
             -     FUNCTIONAL: Functional category
             -     ANALYTICS: Analytics category
             -     ADVERTISING: Advertising category
             -     DATA_TO_THIRD_PARTY: Data to third party category
        - name: html | type: string | description: CustomEmbed's html
     - name: pageFilter | type: PageFilter | description: Page GUIDs where the custom embed should be loaded. By default, custom embeds are applied to all site pages.
        - name: pageIds | type: array | description: Pages where the site embed will be loaded.
  - 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 { customEmbeds } from '@wix/embeds';

customEmbeds.onCustomEmbedUpdated((event) => {
    // handle your event here
});
```


```javascript
import { createClient, AppStrategy } from '@wix/sdk';
import { customEmbeds } from '@wix/embeds';

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

wixClient.customEmbeds.onCustomEmbedUpdated((event) => {
    // handle your event here
});
```

---