Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

event

BadgeAssignedEvent

Triggered when a member receives a badge.

// Place this code in the events.js file
// of your site's Backend section.
// Add the file if it doesn't exist.

export function wixBadges_onBadgeAssigned(event) {
    const memberId = event.data.memberId;
    console.log(`Badge assgigned to member ${memberId}`);
}

/* Full event object:
 * {
 *   "data": {
 *     "memberId": "ff20c02e-3d13-4412-9529-d628aa0abc12"
 *   },
 *   "metadata": {
 *     "entityId": "348b66e1-fb48-4b2d-8a68-6c69e3ac967b",
 *     "eventTime": "2024-03-22T06:09:09.752905936Z",
 *     "id": "25bf06fe-c6bb-4254-a1d0-a98502a6a041",
 *     "triggeredByAnonymizeRequest": false
 *   }
 * }
 */

An event that occurs when a badge is assigned

onBadgeAssigned

void

BadgeCreated

// Place this code in the events.js file
// of your site's Backend section.
// Add the file if it doesn't exist.

export function wixBadges_onBadgeCreated(event){
    const eventTime = event.metadata.eventTime;
    const badgeID = event.entity._id;

    console.log(`Badge ${badgeID} has been created at ${eventTime}`);
}

/* Full event object:
* {
*     "entity": {
*       "_createdDate": "2024-03-29T09:00:20.395Z",
*       "_id": "3e536ad8-486e-45d8-9c0a-eab0cce4f98c",
*       "_updatedDate": "2024-03-29T09:00:20.395Z",
*       "backgroundColor": "#FA8704",
*       "icon": "https://static.wixstatic.com/shapes/cb523e8b3f9b4908b85a4a1c577af32b.svg",
*       "permissionsEnabled": false,
*       "slug": "super-contributer",
*       "textColor": "#FFFFFF",
*       "title": "Super Contributer"
*     },
*     "metadata": {
*       "entityId": "3e536ad8-486e-45d8-9c0a-eab0cce4f98c",
*       "eventTime": "2024-03-29T09:00:20.500072301Z",
*       "id": "b34080a9-798f-4dce-84cd-53a313bcff24",
*       "triggeredByAnonymizeRequest": false
*     }
* }
*/

An event that occurs when a badge is created

onBadgeCreated

BadgeDeleted

// Place this code in the events.js file
// of your site's Backend section.
// Add the file if it doesn't exist.

export function wixBadges_onBadgeDeleted(event){
    const eventTime = event.metadata.eventTime;

    console.log(`Badge has been deleted at ${eventTime}`);
}

/* Full event object:
 * {
 *     "metadata": {
 *       "entityId": "baef3e0b-c3cb-455c-bed4-b139ed0dcc93",
 *       "eventTime": "2024-03-29T08:57:53.336347061Z",
 *       "id": "d09d6a47-dd9f-40e8-bab0-80a9b277a3d2",
 *       "triggeredByAnonymizeRequest": false
 *     }
 * }
 */

An events that occurs when a badge is deleted

onBadgeDeleted

BadgeUnassignedEvent

Triggered when a member's badge is removed.

// Place this code in the events.js file
// of your site's Backend section.
// Add the file if it doesn't exist.

export function wixBadges_onBadgeUnassigned(event){
    const memberID = event.data.memberId;
    const eventTime = event.metadata.eventTime;

    console.log(`Member: ${memberID} has been unassigned from badge at ${eventTime}`);
}

/* Full event object:
 * {
 *     "data": {
 *       "memberId": "a292ced4-245c-49e5-a368-1120b309878d"
 *     },
 *     "metadata": {
 *       "entityId": "baef3e0b-c3cb-455c-bed4-b139ed0dcc93",
 *       "eventTime": "2024-03-29T08:34:42.018598896Z",
 *       "id": "44b43138-5427-4557-bae3-75f4dd1670d2",
 *       "triggeredByAnonymizeRequest": false
 *     }
 * }
 */ 

An event that occurs when a badge is unassigned

onBadgeUnassigned

BadgeUpdated

// Place this code in the events.js file
// of your site's Backend section.
// Add the file if it doesn't exist.

export function wixBadges_onBadgeUpdated(event){
    const badgeID = event.entity._id;
    const eventTime = event.metadata.eventTime;

    console.log(`Badge ID: ${badgeID} has been updated at ${eventTime}`);
}

/* Full event object:
 *  {
 *    "entity": {
 *      "_createdDate": "2024-03-29T09:00:20.395Z",
 *      "_id": "3e536ad8-486e-45d8-9c0a-eab0cce4f98c",
 *      "_updatedDate": "2024-03-29T09:12:59.128Z",
 *      "backgroundColor": "#FF5C79",
 *      "description": "Contributed more than 5 blog posts.",
 *      "icon": "https://static.wixstatic.com/shapes/11062b_73d6472a03884c758f9d39f83a1218c2.svg",
 *      "permissionsEnabled": false,
 *      "slug": "super-contributer",
 *      "textColor": "#796EFF",
 *      "title": "Super Contributer"
 *    },
 *    "metadata": {
 *      "entityId": "3e536ad8-486e-45d8-9c0a-eab0cce4f98c",
 *      "eventTime": "2024-03-29T09:12:59.194287142Z",
 *      "id": "ace58c39-ddd6-467d-9d0a-6ad6cc1be97a",
 *      "triggeredByAnonymizeRequest": false
 *    }
 *  }
*/

An event that occurs when a badge is updated

onBadgeUpdated

Information about the member that was created.

MemberCreated

Triggered when a member is created.

The site owner can configure the site to automatically approve members or require manual approval.

A member who has been approved either automatically or manually has a `status` of `APPROVED`. A created member waiting for approval has a `status` of `PENDING`. A `PENDING` member cannot log into the site.

// Place this code in the events.js file
// of your site's Backend section.
// Add the file if it doesn't exist.

export function wixMembers_onMemberCreated(event) {
  const memberNickname = event.entity.profile.nickname;
  const creationEventId = event.metadata.id;
  const memberId = event.entity._id;

  console.log(`Member with member ID: ${memberId} created.`);
}

/*  Full event object:
 *  {
 *  "metadata": {
 *    "id": "b91e0e4e-1869-4705-ae8c-70b456b2ceed",
 *    "entityId": "583b58eb-708e-4eba-bb8d-af7f9914721b",
 *    "eventTime": "2021-12-10T15:00:29.236054Z",
 *    "triggeredByAnonymizeRequest": false
 *  },
 *  "entity": {
 *    "loginEmail": "john@example.com",
 *    "privacyStatus": "PUBLIC",
 *    "_id": "583b58eb-708e-4eba-bb8d-af7f9914721b",
 *    "_createdDate": "2021-12-10T10:44:37.000Z",
 *    "_updatedDate": "2021-12-10T10:44:36.939Z",
 *    "activityStatus": "ACTIVE",
 *    "profile": {
 *      "profilePhoto": {
 *        "_id": "a27d24_0dd318%7Emv2.jpg",
 *        "url": "http://static.wixstatic.com/media/a27d24_0dd318%7Emv2.jpg",
 *        "height": 0,
 *        "width": 0
 *      },
 *      "slug": "john40355",
 *      "coverPhoto": {
 *        "_id": "",
 *        "url": "https://example.com/myimage.jpg",
 *        "height": 0,
 *        "width": 0
 *      },
 *      "title": "Awesome title",
 *      "nickname": "John Doe"
 *    },
 *    "status": "APPROVED",
 *    "contactId": "583b58eb-708e-4eba-bb8d-af7f9914721b",
 *    "contactDetails": {
 *      "customFields": {
 *        "custom.pet-name": {
 *          "name": "Pet Name",
 *          "value": "Bob"
 *        }
 *      },
 *      "company": "Wix",
 *      "phones": [],
 *      "lastName": "Doe",
 *      "firstName": "John",
 *      "birthdate": "2000-01-01",
 *      "jobTitle": "Developer",
 *      "emails": [
 *        "john@example.com"
 *      ],
 *      "addresses": [
 *        {
 *          "city": "Jewell",
 *          "addressLine": "10 Cedarstone Drive",
 *          "_id": "156e50e8-8127-4617-a052-da66bb9a96a0",
 *          "country": "US",
 *          "postalCode": "43530",
 *          "subdivision": "US-OH"
 *        }
 *      ]
 *    }
 *  }
 *}
 */

An event that occurs when a site member is created

onMemberCreated

Information about the site member that was deleted.

MemberDeleted

// Place this code in the events.js file
// of your site's Backend section.
// Add the file if it doesn't exist.

export function wixMembers_onMemberDeleted(event) {
  const deletionEventId = event.metadata.id;
  
}

/*  Full event object:
 *  {
 *    "metadata": {
 *      "id": "6ee4c618-d1f9-4b4b-aca0-270d6984b79a",
 *      "entityId": "b00d7cd4-9413-4d4f-b9b1-9890f3ce27b9",
 *      "eventTime": "2021-12-13T09:33:13.654270Z",
 *      "triggeredByAnonymizeRequest": false
 *    }
 *  }
 */

An event that occurs when a site member is deleted 

onMemberDeleted

Information about the site member that was updated.

MemberUpdated

// Place this code in the events.js file
// of your site's Backend section.
// Add the file if it doesn't exist.

export function wixMembers_onMemberUpdated(event) {
  const memberUpdateDate = event.entity._updatedDate;
  const updateEventId = event.metadata.id;
}

/*  Full event object:
 *{
 *  "metadata": {
 *    "id": "b91e0e4e-1869-4705-ae8c-70b456b2ceed",
 *    "entityId": "583b58eb-708e-4eba-bb8d-af7f9914721b",
 *    "eventTime": "2021-12-10T15:00:29.236054Z",
 *    "triggeredByAnonymizeRequest": false
 *  },
 *  "entity": {
 *    "loginEmail": "john@example.com",
 *    "privacyStatus": "PUBLIC",
 *    "_id": "583b58eb-708e-4eba-bb8d-af7f9914721b",
 *    "_createdDate": "2021-12-10T10:44:37.000Z",
 *    "_updatedDate": "2021-12-10T10:44:36.939Z",
 *    "activityStatus": "ACTIVE",
 *    "profile": {
 *      "profilePhoto": {
 *        "_id": "a27d24_0dd318%7Emv2.jpg",
 *        "url": "http://static.wixstatic.com/media/a27d24_0dd318%7Emv2.jpg",
 *        "height": 0,
 *        "width": 0
 *      },
 *      "slug": "john40355",
 *      "coverPhoto": {
 *        "_id": "",
 *        "url": "https://example.com/myimage.jpg",
 *        "height": 0,
 *        "width": 0
 *      },
 *      "title": "Awesome title",
 *      "nickname": "John Doe"
 *    },
 *    "status": "APPROVED",
 *    "contactId": "583b58eb-708e-4eba-bb8d-af7f9914721b",
 *    "contactDetails": {
 *      "customFields": {
 *        "custom.pet-name": {
 *          "name": "Pet Name",
 *          "value": "Bob"
 *        }
 *      },
 *      "company": "Wix",
 *      "phones": [],
 *      "lastName": "Doe",
 *      "firstName": "John",
 *      "birthdate": "2000-01-01",
 *      "jobTitle": "Developer",
 *      "emails": [
 *        "john@example.com"
 *      ],
 *      "addresses": [
 *        {
 *          "city": "Jewell",
 *          "addressLine": "10 Cedarstone Drive",
 *          "_id": "156e50e8-8127-4617-a052-da66bb9a96a0",
 *          "country": "US",
 *          "postalCode": "43530",
 *          "subdivision": "US-OH"
 *        }
 *      ]
 *    }
 *  }
 *}
 */

An event that occurs when a site member's information is updated

onMemberUpdated

---
title: Introduction
---

# Introduction

&nbsp;

<div style="background-color: #FEF1D1; padding: 18px 24px; border-radius: 6px; border: 1px solid #FDB10C; box-sizing: border-box; display: inline-block">
    <b>Developer Preview</b>
    <br/>
    <span>APIs in <a href="https://www.wix.com/velo/reference/api-overview/developer-preview">Developer Preview</a> are subject to change and are not intended for use in production.<br/><a href="mailto:velo-preview-feedback@wix.com">Send us</a> your suggestions for improving this API. Your feedback is valuable to us.</span>
</div>
    
&nbsp;

Events are triggered in your site’s backend when certain changes occur to your site’s members. You can write event handlers that react to these events. Event handler functions receive data that correspond to the backend event that has occurred. Use event handlers to create custom responses to the events. 

> **Note:** Backend events don’t work when previewing your site.


## Working with Members Event Handlers

To add a members event handler, add an **events.js** file to the **Backend** or your site if one does not already exist. All event handler functions for your site are defined in this file. 

Event handler functions are defined using the following pattern:
```javascript
export function <wixAppName>_<eventName>(event) { }
```

For example, an event handler that handles the creation of a member looks
like this:
```javascript
export function wixMembers_onMemberCreated(event) { }
```

velo-events_wix-members.v2

BackendEventMetadata

ID of the entity associated with the event.

entityId

string

eventTime

Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users.

triggeredByAnonymizeRequest

boolean

Badge

_createdDate

_updatedDate

Badge background color in hexadecimal RGB format.
Uppercase letters only.
Example: `#FFFFFF`.

backgroundColor

description

URL of the badge icon image.
_Recommended_ to use `SVG` image format as it is resolution independent and looks great at any scale.

icon

Whether the badge has special permissions
to access specific members-only pages.
When `true`, members with the badge receive special permissions,
and site contributors can
[manage badge permissions](https://support.wix.com/en/article/setting-permissions-for-a-member-badge)
in the Dashboard.
When `false`, members with the badge receive no special permissions.

permissionsEnabled

Slugified name. Used to represent the badge in a URL.

slug

Badge text color in hexadecimal RGB format.
Uppercase letters only.
Example: `#C81B53`.

textColor

Text displayed on the badge in the Wix UI.

title

BadgeAssigned

memberId

data

metadata

entity

BadgeUnassigned

ActivityStatusStatus

Address

Main address line, usually street and number, as free text.

addressLine

Street address object, with number and name in separate fields.

streetAddress

Free text providing more detailed address information,
such as apartment, suite, or floor.

addressLine2

city

2-letter country code in an
[ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.

country

postalCode

Code for a subdivision (such as state, prefecture, or province) in an
[ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.

subdivision

Contact

addresses

Contact's birthdate, formatted as `"YYYY-MM-DD"`.

Example: `"2020-03-15"` for March 15, 2020.

birthdate

company

Contact ID.

> **Deprecation notice:**
> This property has been replaced with `member.contactId`
> and will be removed on June 11, 2021.

contactId

Custom fields,
where each key is the field key,
and each value is the field's value for the member.

customFields

emails

firstName

jobTitle

lastName

phones

CustomField

name

value

ExtendedFields

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).

namespaces

Image

Wix Media image ID,
set when the member selects an image from Wix Media.

height

number

offsetX

offsetY

width

Member

Date and time when the member was created.

Date and time when the member was updated.

Member activity status.

- `ACTIVE`: Member can write forum posts and blog comments.
- `MUTED`: Member cannot write forum posts or blog comments.
- `UNKNOWN`: Insufficient permissions to get the status.

activityStatus

Member's contact information. Contact information is stored in the
[Contact List](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts).

The full set of contact data can be accessed and managed with the
[Contacts API](https://dev.wix.com/api/rest/contacts/contacts).

contact

Date and time when the member last logged in to the site.

lastLoginDate

Email used by the member to log in to the site.

loginEmail

Whether the email used by the member has been verified.

loginEmailVerified

Member privacy status.

- `PUBLIC`: Member is visible to everyone.
- `PRIVATE`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.
- `UNKNOWN`: Insufficient permissions to get the status.

privacyStatus

PrivacyStatusStatus

profile

Profile

Member site access status.

- `PENDING`: Member created and is waiting for approval by site owner.
- `APPROVED`: Member can log in to the site.
- `OFFLINE`: Member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-guest-authors-to-your-blog) for the site blog and cannot log in to the site.
- `BLOCKED`: Member is blocked and cannot log in to the site.
- `UNKNOWN`: Insufficient permissions to get the status.

status

Status

Member's cover photo,
used as a background picture in members profile page.

Cover positioning can be altered with `cover.offsetX` and `cover.offsetY`.
When left empty, the values default to `0`.

cover

Name that identifies the member to other members.
Displayed on the member's profile page
and interactions in the forum or blog.

onBadgeUnassigned( )