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

# Namespace: badgesV4

# Webhook link: https://dev.wix.com/docs/api-reference/crm/members-contacts/members/activity/badges-v4/badge-created.md

## Introduction

Triggered when a badge is created.

---

## REST API

### Schema

```
Webhook: Badge Created
Description: Triggered when a badge 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: Badge | description: The created entity.
        - name: id | type: string | description: Badge GUID.
        - name: revision | type: string | description: Revision number, which increments by 1 each time the badge is updated. To prevent conflicting changes, the current revision must be passed when updating the badge.
        - name: title | type: string | description: Badge title displayed on the member's profile.
        - name: description | type: string | description: Badge description explaining its purpose or criteria for earning it.
        - name: backgroundColor | type: string | description: Badge background color in hexadecimal RGB format.
        - name: textColor | type: string | description: Badge text color in hexadecimal RGB format.
        - name: icon | type: Image | description: Badge icon image.  Any image format is accepted with automatic conversion and resizing handled by the system. SVG format is recommended as it is resolution independent and looks great at any scale.
           - name: id | type: string | description: [WixMedia](https://support.wix.com/en/article/wix-media-about-the-media-manager) image GUID. If you pass the GUID, you don't need to pass `url`.
           - name: url | type: string | description: Image URL. Could be any image from the internet.
           - 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. Only applicable when passing `id`.
        - name: permissionsEnabled | type: boolean | description: Whether the badge grants special permissions to access specific members-only pages.  When `true`, members with this badge receive special permissions. Site owners can configure these permissions in the site dashboard. For more information, see [Creating and Managing Member Badges](https://support.wix.com/en/article/site-members-creating-and-managing-member-badges).
        - name: slug | type: string | description: URL-friendly slug for the badge, automatically generated from the title.  Generated by converting the title to lowercase, replacing spaces with hyphens, and removing special characters.
        - name: createdDate | type: string | description: Date and time the badge was created.
        - name: updatedDate | type: string | description: Date and time the badge was last updated.

```

### Examples


```curl
{
  "id": "52269077-05f2-4b59-ba4f-36ef8c4c1e11",
  "entityFqdn": "wix.badges.v4.badge",
  "slug": "created",
  "entityId": "8046df3c-7575-4098-a5ab-c91ad8f33c47",
  "createdEvent": {
    "entity": {
      "id": "8046df3c-7575-4098-a5ab-c91ad8f33c47",
      "revision": 1,
      "title": "Top Contributor",
      "description": "Awarded for being a top contributor in the community",
      "slug": "top-contributor",
      "icon": {
        "url": "https://example.com/badge-icon.png",
        "height": 64,
        "width": 64
      },
      "permissionsEnabled": true,
      "createdDate": "2019-10-30T17:22:10.299Z",
      "updatedDate": "2019-10-30T17:22:10.299Z"
    }
  },
  "eventTime": "2020-10-18T13:40:58.304800Z",
  "triggeredByAnonymizeRequest": false
}

```

---

## JavaScript SDK

### Schema

```
Webhook: onBadgeCreated
Description: Triggered when a badge is created.
Payload: BadgeCreatedEnvelope
  - name: entity | type: Badge | description: none
     - name: _id | type: string | description: Badge GUID.
     - name: revision | type: string | description: Revision number, which increments by 1 each time the badge is updated. To prevent conflicting changes, the current revision must be passed when updating the badge.
     - name: title | type: string | description: Badge title displayed on the member's profile.
     - name: description | type: string | description: Badge description explaining its purpose or criteria for earning it.
     - name: backgroundColor | type: string | description: Badge background color in hexadecimal RGB format.
     - name: textColor | type: string | description: Badge text color in hexadecimal RGB format.
     - name: icon | type: string | description: Badge icon image.  Any image format is accepted with automatic conversion and resizing handled by the system. SVG format is recommended as it is resolution independent and looks great at any scale.
     - name: permissionsEnabled | type: boolean | description: Whether the badge grants special permissions to access specific members-only pages.  When `true`, members with this badge receive special permissions. Site owners can configure these permissions in the site dashboard. For more information, see [Creating and Managing Member Badges](https://support.wix.com/en/article/site-members-creating-and-managing-member-badges).
     - name: slug | type: string | description: URL-friendly slug for the badge, automatically generated from the title.  Generated by converting the title to lowercase, replacing spaces with hyphens, and removing special characters.
     - name: _createdDate | type: Date | description: Date and time the badge was created.
     - name: _updatedDate | type: Date | description: Date and time the badge 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 { badgesV2 } from '@wix/members';

badgesV2.onBadgeCreated((event) => {
    // handle your event here
});
```


```javascript
import { createClient, AppStrategy } from '@wix/sdk';
import { badgesV2 } from '@wix/members';

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

wixClient.badgesV2.onBadgeCreated((event) => {
    // handle your event here
});
```

---