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

# Namespace: voteV1

# Webhook link: https://dev.wix.com/docs/api-reference/crm/community/feedback-moderation/comments/vote-v1/vote-cast.md

# Webhook Permissions Scopes IDs:
## Webhook Code Examples

## Introduction

Triggered when an upvote or downvote is cast, including changes to an existing vote.

---

## REST API

### Schema

```
Webhook: Vote Cast
Description: Triggered when an upvote or downvote is cast, including changes to an existing vote.
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: actionEvent | type: object | description: Custom action event details.
    - name: body | type: VoteCast | description: The event body.
        - name: vote | type: Vote | description: Vote associated with the event.
           - name: resourceId | type: string | description: GUID of the resource receiving the vote. For comments, this is the comment GUID.
           - name: resourceFqdn | type: string | description: Entity type receiving the vote. For comments, this is `wix.comments.v2.comment`.
           - name: voteId | type: string | description: Vote GUID.
           - name: type | type: Type | description: Vote type.
               - enum:
               -     UNKNOWN: Unknown vote type.
               -     UPVOTE: Vote in favor of the resource.
               -     DOWNVOTE: Vote against the resource.
           - name: createdBy | type: SocialIdentity | description: Identity that cast the vote.
              - name: identityId | type: string | description: 
              - name: identityType | type: IdentityType | description: 
                   - enum: ANONYMOUS, MEMBER, USER, SERVICE, MEMBER_GROUP
           - name: createdDate | type: string | description: Date and time the vote was created.
           - name: updatedDate | type: string | description: Date and time the vote was updated.
           - name: context | type: VoteContext | description: App and context containing the resource.
              - name: contextId | type: string | description: GUID of the context containing the resource.
              - name: contextType | type: string | description: Type used by the app to identify the context.
              - name: appDefId | type: string | description: GUID of the app that owns the context.
              - name: metaSiteId | type: string | description: Site GUID.
           - name: revision | type: string | description: Revision number, which increments when the vote is updated.

```

### Examples


```curl
{
  "vote": {
    "resourceId": "90616636-cfe2-4f3d-88ce-1c3d8e3eaa67",
    "resourceFqdn": "wix.comments.v2.comment",
    "voteId": "5361b1fb-4e51-43f8-9247-05e1253b3119",
    "type": "UPVOTE",
    "createdBy": {
      "identityId": "81b3e2a2-60f4-4016-ab20-c2fda4c4c4f2",
      "identityType": "MEMBER"
    },
    "createdDate": "2026-09-09T09:00:00Z",
    "updatedDate": "2026-09-09T09:00:00Z",
    "context": {
      "contextId": "64ad407e0bf87891bba7de3a",
      "appDefId": "91c9d6a7-6667-41fb-b0b4-7d3b3ff0b02e",
      "metaSiteId": "e4c3e43f-bcef-4d73-aee2-ab58ea702d03"
    },
    "revision": "1"
  }
}

```

---

## JavaScript SDK

### Schema

```
Webhook: onVoteCast
Description: Triggered when an upvote or downvote is cast, including changes to an existing vote.
Payload: VoteCastEnvelope
  - name: data | type: VoteCast | description: none
     - name: vote | type: Vote | description: Vote associated with the event.
        - name: resourceId | type: string | description: GUID of the resource receiving the vote. For comments, this is the comment GUID.
        - name: resourceFqdn | type: string | description: Entity type receiving the vote. For comments, this is `wix.comments.v2.comment`.
        - name: voteId | type: string | description: Vote GUID.
        - name: type | type: Type | description: Vote type.
             - enum:
             -     UNKNOWN: Unknown vote type.
             -     UPVOTE: Vote in favor of the resource.
             -     DOWNVOTE: Vote against the resource.
        - name: createdBy | type: SocialIdentity | description: Identity that cast the vote.
           - name: identityId | type: string | description: 
           - name: identityType | type: IdentityType | description: 
                 - enum: ANONYMOUS, MEMBER, USER, SERVICE, MEMBER_GROUP
        - name: _createdDate | type: Date | description: Date and time the vote was created.
        - name: _updatedDate | type: Date | description: Date and time the vote was updated.
        - name: context | type: VoteContext | description: App and context containing the resource.
           - name: contextId | type: string | description: GUID of the context containing the resource.
           - name: contextType | type: string | description: Type used by the app to identify the context.
           - name: appDefId | type: string | description: GUID of the app that owns the context.
           - name: metaSiteId | type: string | description: Site GUID.
        - name: revision | type: string | description: Revision number, which increments when the vote is 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 { votes } from '@wix/comments';

votes.onVoteCast((event) => {
    // handle your event here
});
```


```javascript
import { createClient, AppStrategy } from '@wix/sdk';
import { votes } from '@wix/comments';

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

wixClient.votes.onVoteCast((event) => {
    // handle your event here
});
```

---