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

# Namespace: category

# Webhook link: https://dev.wix.com/docs/api-reference/business-solutions/blog/category/category-created.md

## Introduction

Triggered when a category is created.

---

## REST API

### Schema

```
Webhook: Category Created
Description: Triggered when a category 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: Category | description: The created entity.
        - name: id | type: string | description: Category GUID.
        - name: label | type: string | description: Category label. Displayed in the Category Menu.
        - name: postCount | type: integer | description: Number of posts in the category.
        - name: url | type: PageUrl | description: The `url` of the page that lists every post with the specified category.
           - name: base | type: string | description: The base URL. For premium sites, this is the domain. For free sites, this is the site URL. For example, `mysite.wixsite.com/mysite`.
           - name: path | type: string | description: The relative path for the page within the site. For example, `/product-page/a-product`.
        - name: description | type: string | description: Category description.
        - name: displayPosition | type: integer | description: Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu). Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.  Default: `-1`
        - name: translationId | type: string | description: GUID of the category's translations. All translations of a single category share the same `translationId`.
        - name: language | type: string | description: Category language.  2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
        - name: slug | type: string | description: Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`.
        - name: seoData | type: SeoSchema | description: 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: coverImage | type: Image | description: Category cover image.
           - name: id | type: string | description: WixMedia image GUID.
           - name: url | type: string | description: Image URL.
           - name: height | type: integer | description: Original image height.
           - name: width | type: integer | description: Original image width.
           - name: altText | type: string | description: Image alt text.
           - name: filename | type: string | description: Image filename.
        - name: updatedDate | type: string | description: Date and time the Category was last updated.

```

### Examples


```curl
{
  "entityId": "71d1ead7-a341-4853-8f32-d5534e274473",
  "slug": "created",
  "id": "0002d822-bcf6-473f-8879-d913b788fd3c",
  "createdEvent": {
    "entity": {
      "id": "71d1ead7-a341-4853-8f32-d5534e274473",
      "label": "Membership Posts",
      "url": {
        "base": "https://www.darlingmagnolia.com",
        "path": "/blog/categories/membership-posts"
      },
      "description": "Exclusive Membership blog posts",
      "coverMedia": {
        "enabled": true,
        "displayed": true
      },
      "displayPosition": 4,
      "slug": "membership",
      "language": "en"
    }
  },
  "entityFqdn": "wix.blog.category",
  "eventTime": "2021-03-02T10:24:16.556Z"
}
```

---

## JavaScript SDK

### Schema

```
Webhook: onCategoryCreated
Description: Triggered when a category is created.
Payload: CategoryCreatedEnvelope
  - name: entity | type: Category | description: none
     - name: _id | type: string | description: Category GUID.
     - name: label | type: string | description: Category label. Displayed in the Category Menu.
     - name: postCount | type: integer | description: Number of posts in the category.
     - name: url | type: string | description: The `url` of the page that lists every post with the specified category.
     - name: description | type: string | description: Category description.
     - name: displayPosition | type: integer | description: Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu). Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.  Default: `-1`
     - name: translationId | type: string | description: GUID of the category's translations. All translations of a single category share the same `translationId`.
     - name: language | type: string | description: Category language.  2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
     - name: slug | type: string | description: Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`.
     - name: seoData | type: SeoSchema | description: 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: coverImage | type: string | description: Category cover image.
     - name: _updatedDate | type: Date | description: Date and time the Category was last updated.
  - 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 { categories } from '@wix/blog';

categories.onCategoryCreated((event) => {
    // handle your event here
});
```


```javascript
import { createClient, AppStrategy } from '@wix/sdk';
import { categories } from '@wix/blog';

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

wixClient.categories.onCategoryCreated((event) => {
    // handle your event here
});
```

---