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

# Namespace: emailDesignTheme

# Webhook link: https://dev.wix.com/docs/api-reference/business-management/marketing/emails/email-design-theme/email-design-theme-created.md

# Webhook Permissions Scopes IDs:
Read Email Marketing: SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING

## Introduction

Triggered when an email design theme is created.

---

## REST API

### Schema

```
Webhook: Email Design Theme Created
Description: Triggered when an email design theme is created.
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: createdEvent | type: object | description: Created event details.
    - name: entity | type: EmailDesignTheme | description: The created entity.
        - name: id | type: string | description: Email design theme GUID.
        - name: createdDate | type: string | description: Date and time the email design theme was created.
        - name: updatedDate | type: string | description: Date and time the email design theme was updated.
        - name: revision | type: string | description: Revision number, which increments by 1 each time the email design theme is updated. To prevent conflicting changes, the current revision must be passed when updating the email design theme.  Ignored when creating an email design theme.
        - name: title | type: string | description: Email design theme title. Titles aren't unique, so a site can have multiple email design themes with the same title. To help site owners tell them apart, display additional context alongside the title, such as the date the email design theme was last updated.
        - name: body | type: object | description: Styling definition of the email design theme, as a free-form JSON object. Its structure is defined by the Wix email editor. For example, `palette` holds the theme's colors, and `classes` maps named styles such as `heading-text` and `primary-button` to the properties the editor applies.  The Wix email editor doesn't render styling that doesn't follow its structure. When `body` doesn't define a style class, the editor uses its default styling for that class. When `body` doesn't include `palette`, the theme's color palette is empty.  This API doesn't validate the structure of `body`, so a theme that saves successfully may still not render as expected. Don't rely on a particular set of keys being present, and ignore keys you don't recognize. Don't store personal data in `body`.  Limited to 256 KB (262,144 bytes), measured on the JSON encoding without insignificant whitespace.
        - name: extendedFields | type: ExtendedFields | description: Custom field data for the email design theme.  [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. Don't store personal data in extended fields.  To update extended fields, call [Update Extended Fields](https://dev.wix.com/docs/api-reference/business-management/marketing/emails/email-design-theme/update-extended-fields.md). [Update Email Design Theme](https://dev.wix.com/docs/api-reference/business-management/marketing/emails/email-design-theme/update-email-design-theme.md) also applies any `extendedFields` specified in the request.
           - 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: Tags assigned to the email design theme. Tags are owned by the Tags API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/tags/tags/introduction.md) | [REST](https://dev.wix.com/docs/rest/business-management/tags/introduction.md)), which you can use to resolve these GUIDs into labels and to create tags.  Specifying `tags` in [Update Email Design Theme](https://dev.wix.com/docs/api-reference/business-management/marketing/emails/email-design-theme/update-email-design-theme.md) replaces the existing tags instead of adding to them. To assign or unassign individual tags, call [Bulk Update Email Design Theme Tags](https://dev.wix.com/docs/api-reference/business-management/marketing/emails/email-design-theme/bulk-update-email-design-theme-tags.md).
           - name: privateTags | type: TagList | description: Tags that require an additional permission to access, typically restricted from site members and visitors.
              - name: tagIds | type: array<string> | description: List of tag GUIDs.
           - name: publicTags | type: TagList | description: Tags that are exposed to anyone with access to the entity, including site members and visitors.

```

### Examples


```curl
{
  "id": "52269077-05f2-4b59-ba4f-36ef8c4c1e11",
  "entityFqdn": "wix.emails.themes.v1.email_design_theme",
  "slug": "created",
  "entityId": "7f3c2a91-6d84-4b17-a5e2-9c1f8d73b604",
  "createdEvent": {
    "entity": {
      "id": "7f3c2a91-6d84-4b17-a5e2-9c1f8d73b604",
      "revision": "1",
      "createdDate": "2024-01-01T00:00:00.000Z",
      "updatedDate": "2024-01-01T00:00:00.000Z",
      "title": "Timeless Editorial Elegance",
      "body": {
        "body": {
          "width": "700px",
          "backgroundColor": "#E3E0D8"
        },
        "classes": {
          "heading-text": {
            "style": {
              "color": "#0C1622",
              "fontFamily": "Georgia,'Times New Roman',serif",
              "fontSize": "44px"
            }
          },
          "section": {
            "style": {
              "padding": "40px 32px",
              "backgroundColor": "#F3F1EC"
            }
          },
          "primary-button": {
            "style": {
              "backgroundColor": "#0C1622",
              "innerPadding": "16px 28px",
              "color": "#F3F1EC",
              "fontFamily": "Helvetica,Arial,sans-serif",
              "fontSize": "13px"
            }
          }
        },
        "palette": [
          "#F3F1EC",
          "#0C1622",
          "#080E16",
          "#2E3742"
        ]
      }
    }
  },
  "eventTime": "2024-01-01T00:00:00.120Z",
  "triggeredByAnonymizeRequest": false,
  "entityEventSequence": "1"
}

```

---

## JavaScript SDK

### Schema

```
Webhook: onEmailDesignThemeCreated
Description: Triggered when an email design theme is created.
Payload: EmailDesignThemeCreatedEnvelope
  - name: entity | type: EmailDesignTheme | description: none
     - name: _id | type: string | description: Email design theme GUID.
     - name: _createdDate | type: Date | description: Date and time the email design theme was created.
     - name: _updatedDate | type: Date | description: Date and time the email design theme was updated.
     - name: revision | type: string | description: Revision number, which increments by 1 each time the email design theme is updated. To prevent conflicting changes, the current revision must be passed when updating the email design theme.  Ignored when creating an email design theme.
     - name: title | type: string | description: Email design theme title. Titles aren't unique, so a site can have multiple email design themes with the same title. To help site owners tell them apart, display additional context alongside the title, such as the date the email design theme was last updated.
     - name: body | type: object | description: Styling definition of the email design theme, as a free-form JSON object. Its structure is defined by the Wix email editor. For example, `palette` holds the theme's colors, and `classes` maps named styles such as `heading-text` and `primary-button` to the properties the editor applies.  The Wix email editor doesn't render styling that doesn't follow its structure. When `body` doesn't define a style class, the editor uses its default styling for that class. When `body` doesn't include `palette`, the theme's color palette is empty.  This API doesn't validate the structure of `body`, so a theme that saves successfully may still not render as expected. Don't rely on a particular set of keys being present, and ignore keys you don't recognize. Don't store personal data in `body`.  Limited to 256 KB (262,144 bytes), measured on the JSON encoding without insignificant whitespace.
     - name: extendedFields | type: ExtendedFields | description: Custom field data for the email design theme.  [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. Don't store personal data in extended fields.  To update extended fields, call [Update Extended Fields](https://dev.wix.com/docs/api-reference/business-management/marketing/emails/email-design-theme/update-extended-fields.md). [Update Email Design Theme](https://dev.wix.com/docs/api-reference/business-management/marketing/emails/email-design-theme/update-email-design-theme.md) also applies any `extendedFields` specified in the request.
        - 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: Tags assigned to the email design theme. Tags are owned by the Tags API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/tags/tags/introduction.md) | [REST](https://dev.wix.com/docs/rest/business-management/tags/introduction.md)), which you can use to resolve these GUIDs into labels and to create tags.  Specifying `tags` in [Update Email Design Theme](https://dev.wix.com/docs/api-reference/business-management/marketing/emails/email-design-theme/update-email-design-theme.md) replaces the existing tags instead of adding to them. To assign or unassign individual tags, call [Bulk Update Email Design Theme Tags](https://dev.wix.com/docs/api-reference/business-management/marketing/emails/email-design-theme/bulk-update-email-design-theme-tags.md).
        - name: privateTags | type: TagList | description: Tags that require an additional permission to access, typically restricted from site members and visitors.
           - name: tagIds | type: array<string> | description: List of tag GUIDs.
        - name: publicTags | type: TagList | description: Tags that are exposed to anyone with access to the entity, 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 { emailDesignThemes } from '@wix/email-design-themes';

emailDesignThemes.onEmailDesignThemeCreated((event) => {
    // handle your event here
});
```


```javascript
import { createClient, AppStrategy } from '@wix/sdk';
import { emailDesignThemes } from '@wix/email-design-themes';

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

wixClient.emailDesignThemes.onEmailDesignThemeCreated((event) => {
    // handle your event here
});
```

---