Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

event

CategoryCreated


  export function wixForumV1_onCategoryCreated(event) {
    const eventId = event.metadata.id
    const entityId = event.entity._id;
  }

  

onCategoryCreated example

onCategoryCreated

void

CategoryDeleted


  export function wixForumV1_onCategoryDeleted(event) {
    const eventId = event.metadata.id
    const entityId = event.entity._id;
  }

  

onCategoryDeleted example

onCategoryDeleted

CategoryUpdated


  export function wixForumV1_onCategoryUpdated(event) {
    const eventId = event.metadata.id
    const entityId = event.entity._id;
  }

  

onCategoryUpdated example

onCategoryUpdated

PostClosed

An existing post was closed for further comments.


  export function wixForumV1_onPostClosed(event) {
    const eventId = event.metadata.id
    const entityId = event.data.post._id;
  }

  

onPostClosed example

onPostClosed

PostCreated


  export function wixForumV1_onPostCreated(event) {
    const eventId = event.metadata.id
    const entityId = event.entity._id;
  }

  

onPostCreated example

onPostCreated

PostDeleted


  export function wixForumV1_onPostDeleted(event) {
    const eventId = event.metadata.id
    const entityId = event.entity._id;
  }

  

onPostDeleted example

onPostDeleted

PostLiked


  export function wixForumV1_onPostLiked(event) {
    const eventId = event.metadata.id
    const entityId = event.data.post._id;
  }

  

onPostLiked example

onPostLiked

PostMoved

An existing post was moved to a different category.


  export function wixForumV1_onPostMoved(event) {
    const eventId = event.metadata.id
    const entityId = event.data.post._id;
  }

  

onPostMoved example

onPostMoved

PostOpened

An existing post was opened for further comments.


  export function wixForumV1_onPostOpened(event) {
    const eventId = event.metadata.id
    const entityId = event.data.post._id;
  }

  

onPostOpened example

onPostOpened

PostPinned

An existing post was pinned to the top of the post list.


  export function wixForumV1_onPostPinned(event) {
    const eventId = event.metadata.id
    const entityId = event.data.post._id;
  }

  

onPostPinned example

onPostPinned

PostReported

An existing post was reported as inappropriate.


  export function wixForumV1_onPostReported(event) {
    const eventId = event.metadata.id
    const entityId = event.data.post._id;
  }

  

onPostReported example

onPostReported

PostUnliked


  export function wixForumV1_onPostUnliked(event) {
    const eventId = event.metadata.id
    const entityId = event.data.post._id;
  }

  

onPostUnliked example

onPostUnliked

PostUnpinned

An existing post was unpinned from the top of the post list.


  export function wixForumV1_onPostUnpinned(event) {
    const eventId = event.metadata.id
    const entityId = event.data.post._id;
  }

  

onPostUnpinned example

onPostUnpinned

PostUpdated


  export function wixForumV1_onPostUpdated(event) {
    const eventId = event.metadata.id
    const entityId = event.entity._id;
  }

  

onPostUpdated example

onPostUpdated

PostReacted


  export function wixForum_onPostReacted(event) {
    const eventId = event.metadata.id
    const entityId = event.data.post._id;
  }

  

onPostReacted example

onPostReacted

PostUnreacted


  export function wixForum_onPostUnreacted(event) {
    const eventId = event.metadata.id
    const entityId = event.data.post._id;
  }

  

onPostUnreacted example

onPostUnreacted

---
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;


Wix Forum events are triggered on your site's backend when certain events occur on your site's forum.
You can write event handlers that react to these events. Event handler functions receive data
that corresponds to the event that was fired. Use event handlers to create custom responses
to forum events. 

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


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




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 category looks like:
```javascript
export function wixForum_onCategoryCreated(event) {}
```

velo-events_wix-forum.v2

Access

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

_createdDate

_updatedDate

Defines what additional reactions may be applied on the comment under the posts created in this category.

additionalCommentReactions

Defines what additional reactions may be applied on the posts created in this category.

additionalPostReactions

Whether all site visitors and members (`PUBLIC`), all members (`MEMBERS_ONLY`), or only specific members and groups of members with roles, badges or paid subscriptions (`PRIVATE`) can access posts in category.

categoryAccess

Defines what interactions may be applied on the comment under the posts created in this category, vote or like.

commentInteraction

Interaction

description

Ids of groups which can access category if categoryAccess is PRIVATE.

groups

headerImage

headerTitle

headerType

HeaderType

Defines which icon will be used for the main reaction on the comment under the posts created in this category.

Default `type`: `"LIKE"`.

mainCommentReaction

Reaction

Defines which icon will be used for main reaction on the posts created in this category.

Default `type`: `"LIKE"`.

mainPostReaction

name

Whether only admins and moderators can write posts in category.

noMemberPosting

parentId

postCount

number

Defines what interactions may be applied on the posts created in this category, like or multiple reactions.

postInteraction

PostInteraction

List of post type that Category supports.
Deprecated on '2021-08-03'.

postTypes

postViewCount

rank

slug

entity

metadata

ColorComponent

color

opacity

CommentOrder

Keyword

Whether the keyword is the main focus keyword.

isMain

term

PostType

type

code

SeoSchema

settings

Settings

keywords

Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.


Default: `false` (Auto Redirect is enabled.)

preventAutoRedirect

SEO tag inner content. For example, `<title> inner content </title>`.

children

custom

disabled

SEO tag meta data. For example, `{height: 300, width: 240}`.

props

SEO tag type.


Supported values: `title`, `meta`, `script`, `link`.

Type

Closed

postId

EntityType

Identity

identityId

identityType

IdentityType

Liked

Moved

currentCategoryId

oldCategoryId

Opened

Pinned

Post

ID of the best answer comment for this post (selected by forum admin or post owner).
Deprecated on '2022-08-24' use markedComments instead.

bestAnswerCommentId

categoryId

Whether post is closed and commenting is disabled.

closed

commentCount

Defines what interactions may be applied on the comment under the post, vote or like.

contentText

images

Date of latest activity on this post (e.g., date the latest comment was added to post).

lastActivityDate

likeCount

IDs of the marked comments for this post. Posts are marked by the forum admin or the post owner.

onPostUnpinned( )