Search.../
  1. REST
Generate a test token to explore our APIs

Pinned Webhook

Developer Preview

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

Permissions

This webhook requires the Read Forums permission scope.

Event Body

Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.

Event Data

NAME
TYPE
DESCRIPTION
id
string

Unique event ID.

entityFqdn
string

Expected wix.forum.post. Fully Qualified Domain Name.

slug
string

Expected pinned. Event name.

actionEvent
object

Event Info

entityId
string

Pinned ID associated with this event.

eventTime
string

Event timestamp.

triggeredByAnonymizeRequest
boolean

Whether this event was triggered as a result of a privacy regulation application (e.g., GDPR).

Was this helpful?

The data payload will include the following as an encoded JWT:

Event Body

json

1{
2 "data": {
3 "eventType": "wix.forum.post_pinned",
4 "instanceId": "<app-instance-id>",
5 "data": "<stringified-JSON>"
6 }
7}

The parsed data will include:

Sample Data

json

1{
2 "id" : "0ec75a41-ae29-4e5e-8063-46f5a5d925d9",
3 "entityFqdn" : "wix.forum.post",
4 "slug" : "pinned",
5 "entityId" : "612c7083301bb900165cbf95",
6 "actionEvent" : {
7 "bodyAsJson" : {
8 "postId" : "612c7083301bb900165cbf95"
9 }
10 },
11 "eventTime" : "2021-08-30T08:44:20.629071Z",
12 "triggeredByAnonymizeRequest" : false
13}