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

# Namespace: collections

# Webhook link: https://dev.wix.com/docs/api-reference/business-solutions/portfolio/collections/collection-created.md

## Introduction

Triggered when a collection is created.

---

## REST API

### Schema

```
Webhook: Collection Created
Description: Triggered when a collection 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: Collection | description: The created entity.
        - name: id | type: string | description: Collection GUID.
        - name: revision | type: string | description: Revision number, which increments by 1 each time the collection is updated. To prevent conflicting changes, the existing revision must be passed when updating the collection object.
        - name: title | type: string | description: Collection title.
        - name: description | type: string | description: Collection description.
        - name: slug | type: string | description: Collection slug.
        - name: coverImage | type: Image | description: Collection cover image.
           - name: imageInfo | type: Image | description: Information about the Wix Media image.
              - name: id | type: string | description: WixMedia image GUID. Required.
              - name: url | type: string | description: Image URL.
              - name: height | type: integer | description: Original image height. Required.
              - name: width | type: integer | description: Original image width. Required.
              - name: altText | type: string | description: Image alt text.
              - name: filename | type: string | description: Image filename.
           - name: focalPoint | type: Point | description: Focal point of the image.
              - name: x | type: number | description: X-coordinate of the focal point.
              - name: y | type: number | description: Y-coordinate of the focal point.
        - name: hidden | type: boolean | description: Whether the collection is hidden from the portfolio. Default: `false`
        - name: sortOrder | type: number | description: Index that determines which position a collection is displayed in the portfolio. <br />  Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
        - name: createdDate | type: string | description: Date and time the collection was created.
        - name: updatedDate | type: string | description: Date and time the collection was updated.
        - name: url | type: PageUrlV2 | description: Collection page URL and relative path. Returned when `includePageUrl` is `true` in the request.
           - name: relativePath | type: string | description: The relative path for the page within the site. For example, `/product-page/a-product`.
           - name: url | type: string | description: The page's full URL. For example, `https://mysite.com/product-page/a-product`.
        - name: seoData | type: SeoSchema | description: Collection SEO data.
           - name: tags | type: array<Tag> | description: SEO tag information.
              - name: type | type: string | description: SEO tag type.   Supported values: `title`, `meta`, `script`, `link`.
              - name: props | type: object | description: A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value. For example: `{"name": "description", "content": "the description itself"}`.
              - name: meta | type: object | description: SEO tag metadata. For example, `{"height": 300, "width": 240}`.
              - name: children | type: string | description: SEO tag inner content. For example, `<title> inner content </title>`.
              - name: custom | type: boolean | description: Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).
              - name: disabled | type: boolean | description: Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines.
           - name: settings | type: Settings | description: SEO general settings.
              - name: preventAutoRedirect | type: boolean | description: Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.   Default: `false` (automatical redirect is enabled).
              - name: keywords | type: array<Keyword> | description: User-selected keyword terms for a specific page.
                 - name: term | type: string | description: Keyword value.
                 - name: isMain | type: boolean | description: Whether the keyword is the main focus keyword.
                 - name: origin | type: string | description: The source that added the keyword terms to the SEO settings.

```

---

## JavaScript SDK

### Schema

```
Webhook: onCollectionCreated
Description: Triggered when a collection is created.
Payload: CollectionCreatedEnvelope
  - name: entity | type: Collection | description: none
     - name: _id | type: string | description: Collection GUID.
     - name: revision | type: string | description: Revision number, which increments by 1 each time the collection is updated. To prevent conflicting changes, the existing revision must be passed when updating the collection object.
     - name: title | type: string | description: Collection title.
     - name: description | type: string | description: Collection description.
     - name: slug | type: string | description: Collection slug.
     - name: coverImage | type: Image | description: Collection cover image.
        - name: imageInfo | type: string | description: Information about the Wix Media image.
        - name: focalPoint | type: Point | description: Focal point of the image.
           - name: x | type: number | description: X-coordinate of the focal point.
           - name: y | type: number | description: Y-coordinate of the focal point.
     - name: hidden | type: boolean | description: Whether the collection is hidden from the portfolio. Default: `false`
     - name: sortOrder | type: number | description: Index that determines which position a collection is displayed in the portfolio. <br />  Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
     - name: _createdDate | type: Date | description: Date and time the collection was created.
     - name: _updatedDate | type: Date | description: Date and time the collection was updated.
     - name: url | type: string | description: Collection page URL and relative path. Returned when `includePageUrl` is `true` in the request.
     - name: seoData | type: SeoSchema | description: Collection SEO data.
        - name: tags | type: array<Tag> | description: SEO tag information.
           - name: type | type: string | description: SEO tag type.   Supported values: `title`, `meta`, `script`, `link`.
           - name: props | type: object | description: A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value. For example: `{"name": "description", "content": "the description itself"}`.
           - name: meta | type: object | description: SEO tag metadata. For example, `{"height": 300, "width": 240}`.
           - name: children | type: string | description: SEO tag inner content. For example, `<title> inner content </title>`.
           - name: custom | type: boolean | description: Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).
           - name: disabled | type: boolean | description: Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines.
        - name: settings | type: Settings | description: SEO general settings.
           - name: preventAutoRedirect | type: boolean | description: Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.   Default: `false` (automatical redirect is enabled).
           - name: keywords | type: array<Keyword> | description: User-selected keyword terms for a specific page.
              - name: term | type: string | description: Keyword value.
              - name: isMain | type: boolean | description: Whether the keyword is the main focus keyword.
              - name: origin | type: string | description: The source that added the keyword terms to the SEO settings.
  - 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 { collections } from '@wix/portfolio';

collections.onCollectionCreated((event) => {
    // handle your event here
});
```


```javascript
import { createClient, AppStrategy } from '@wix/sdk';
import { collections } from '@wix/portfolio';

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

wixClient.collections.onCollectionCreated((event) => {
    // handle your event here
});
```

---