Post Object

Attributes

id
string
READ ONLY
Post ID.
categoryId
string
Category ID the post is listed under.
ownerId
string
READ ONLY
Post owner's member ID.
title
string
minLength 1
,
maxLength 140
.
Post title.
contentText
string
The post content in plain text.
commentCount
integer
READ ONLY
format int32
.
Total number of post comments.
likeCount
integer
READ ONLY
format int32
.
Total number of post likes.
viewCount
integer
READ ONLY
format int32
.
Total number of post views.
createdDate
string
READ ONLY
format date-time
.
Date post was created.
lastActivityDate
string
READ ONLY
format date-time
.
Date of latest activity on this post (e.g., date the latest comment was added to post).
url
object
Post URL.
slug
string
READ ONLY
Post slug.
bestAnswerCommentId
string
READ ONLY
ID of the best answer comment for this post (selected by forum admin or post owner). Deprecated on '2022-08-24' use markedComments instead.
images
Array <Image>
READ ONLY
Images from post content.
videos
Array <VideoV2>
READ ONLY
Videos from post content.
pinned
boolean
Whether the post is pinned. Places the post at the top of the post list.
closed
boolean
Whether post is closed and commenting is disabled.
updatedDate
string
format date-time
.
Date post was updated.
commentInteraction
string
4 supported values:

UNKNOWN, REACTION, VOTE, NONE,

Defines what interactions may be applied on the comment under the post, vote or like.
markedComments
Array <string>
READ ONLY
maxItems 10
.
IDs of the marked comment for this post (selected by forum admin or post owner).
recentActivity
object
Recent activity of post (e.g., activity of the latest comment was added to post).
reactionIdentities
Array <ReactionIdentity>
READ ONLY
maxItems 6
.
List of reaction identities grouped by reaction code.
Was this helpful?
Yes
No
get

Get Post

Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a single post by ID.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Forums
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Was this helpful?
Yes
No
get

Get Post By Slug

Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a single post by URL slug.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Forums
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Was this helpful?
Yes
No
post

Query Posts

Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Returns a list of posts by query.

Paging

  • limit: default - 10, min - 0, max - 100
  • offset: default - 0, min - 0

Filterable fields:

  • id
  • categoryId
  • ownerId
  • title
  • contentText
  • bestAnswerCommentId
  • pinned
  • commentingEnabled
  • commentCount
  • likeCount
  • viewCount
  • createdDate
  • editedDate
  • lastActivityDate
  • slug

Sortable fields:

  • lastActivityDate
  • createdDate
  • commentCount
  • viewCount
  • likeCount
  • pinned

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Forums
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Was this helpful?
Yes
No

Post Created

Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

A new post was created.

Permissions

WIX_FORUM.CATEGORY_READ_ALL
Learn more about permissions.

Event Body

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

id
string
Unique event ID. Allows clients to ignore duplicate webhooks.
entityFqdn
string
Fully qualified domain name of the entity associated with the event. Expected
wix.forum.post
.
slug
string
Event name. Expected
created
.
entityId
string
ID of the entity associated with the event.
eventTime
string
format date-time
.
Event timestamp.
triggeredByAnonymizeRequest
boolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
originatedFrom
string
If present, indicates the action that triggered the event.
createdEvent
object
Event information.
Was this helpful?
Yes
No

Post Updated

Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

An existing post was updated.

Permissions

WIX_FORUM.CATEGORY_READ_ALL
Learn more about permissions.

Event Body

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

id
string
Unique event ID. Allows clients to ignore duplicate webhooks.
entityFqdn
string
Fully qualified domain name of the entity associated with the event. Expected
wix.forum.post
.
slug
string
Event name. Expected
updated
.
entityId
string
ID of the entity associated with the event.
eventTime
string
format date-time
.
Event timestamp.
triggeredByAnonymizeRequest
boolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
originatedFrom
string
If present, indicates the action that triggered the event.
updatedEvent
object
Event information.
Was this helpful?
Yes
No

Post Deleted

Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

An existing post was removed.

Permissions

WIX_FORUM.CATEGORY_READ_ALL
Learn more about permissions.

Event Body

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

id
string
Unique event ID. Allows clients to ignore duplicate webhooks.
entityFqdn
string
Fully qualified domain name of the entity associated with the event. Expected
wix.forum.post
.
slug
string
Event name. Expected
deleted
.
entityId
string
ID of the entity associated with the event.
eventTime
string
format date-time
.
Event timestamp.
triggeredByAnonymizeRequest
boolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
originatedFrom
string
If present, indicates the action that triggered the event.
deletedEvent
struct
Event information.
Was this helpful?
Yes
No

Moved

Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

An existing post was moved to a different category.

Permissions

WIX_FORUM.CATEGORY_READ_ALL
Learn more about permissions.

Event Body

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

id
string
Unique event ID. Allows clients to ignore duplicate webhooks.
entityFqdn
string
Fully qualified domain name of the entity associated with the event. Expected
wix.forum.post
.
slug
string
Event name. Expected
moved
.
entityId
string
ID of the entity associated with the event.
eventTime
string
format date-time
.
Event timestamp.
triggeredByAnonymizeRequest
boolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
originatedFrom
string
If present, indicates the action that triggered the event.
actionEvent
object
Event information.
Was this helpful?
Yes
No

Liked

Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

An existing post was liked.

Permissions

WIX_FORUM.CATEGORY_READ_ALL
Learn more about permissions.

Event Body

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

id
string
Unique event ID. Allows clients to ignore duplicate webhooks.
entityFqdn
string
Fully qualified domain name of the entity associated with the event. Expected
wix.forum.post
.
slug
string
Event name. Expected
liked
.
entityId
string
ID of the entity associated with the event.
eventTime
string
format date-time
.
Event timestamp.
triggeredByAnonymizeRequest
boolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
originatedFrom
string
If present, indicates the action that triggered the event.
actionEvent
object
Event information.
Was this helpful?
Yes
No

Unliked

Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

An existing post was unliked.

Permissions

WIX_FORUM.CATEGORY_READ_ALL
Learn more about permissions.

Event Body

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

id
string
Unique event ID. Allows clients to ignore duplicate webhooks.
entityFqdn
string
Fully qualified domain name of the entity associated with the event. Expected
wix.forum.post
.
slug
string
Event name. Expected
unliked
.
entityId
string
ID of the entity associated with the event.
eventTime
string
format date-time
.
Event timestamp.
triggeredByAnonymizeRequest
boolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
originatedFrom
string
If present, indicates the action that triggered the event.
actionEvent
object
Event information.
Was this helpful?
Yes
No

Pinned

Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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

Permissions

WIX_FORUM.CATEGORY_READ_ALL
Learn more about permissions.

Event Body

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

id
string
Unique event ID. Allows clients to ignore duplicate webhooks.
entityFqdn
string
Fully qualified domain name of the entity associated with the event. Expected
wix.forum.post
.
slug
string
Event name. Expected
pinned
.
entityId
string
ID of the entity associated with the event.
eventTime
string
format date-time
.
Event timestamp.
triggeredByAnonymizeRequest
boolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
originatedFrom
string
If present, indicates the action that triggered the event.
actionEvent
object
Event information.
Was this helpful?
Yes
No

Unpinned

Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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

Permissions

WIX_FORUM.CATEGORY_READ_ALL
Learn more about permissions.

Event Body

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

id
string
Unique event ID. Allows clients to ignore duplicate webhooks.
entityFqdn
string
Fully qualified domain name of the entity associated with the event. Expected
wix.forum.post
.
slug
string
Event name. Expected
unpinned
.
entityId
string
ID of the entity associated with the event.
eventTime
string
format date-time
.
Event timestamp.
triggeredByAnonymizeRequest
boolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
originatedFrom
string
If present, indicates the action that triggered the event.
actionEvent
object
Event information.
Was this helpful?
Yes
No

Closed

Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

An existing post was closed for further comments.

Permissions

WIX_FORUM.CATEGORY_READ_ALL
Learn more about permissions.

Event Body

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

id
string
Unique event ID. Allows clients to ignore duplicate webhooks.
entityFqdn
string
Fully qualified domain name of the entity associated with the event. Expected
wix.forum.post
.
slug
string
Event name. Expected
closed
.
entityId
string
ID of the entity associated with the event.
eventTime
string
format date-time
.
Event timestamp.
triggeredByAnonymizeRequest
boolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
originatedFrom
string
If present, indicates the action that triggered the event.
actionEvent
object
Event information.
Was this helpful?
Yes
No

Opened

Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

An existing post was opened for further comments.

Permissions

WIX_FORUM.CATEGORY_READ_ALL
Learn more about permissions.

Event Body

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

id
string
Unique event ID. Allows clients to ignore duplicate webhooks.
entityFqdn
string
Fully qualified domain name of the entity associated with the event. Expected
wix.forum.post
.
slug
string
Event name. Expected
opened
.
entityId
string
ID of the entity associated with the event.
eventTime
string
format date-time
.
Event timestamp.
triggeredByAnonymizeRequest
boolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
originatedFrom
string
If present, indicates the action that triggered the event.
actionEvent
object
Event information.
Was this helpful?
Yes
No

Reported

Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

An existing post was reported as inappropriate.

Permissions

WIX_FORUM.CATEGORY_READ_ALL
Learn more about permissions.

Event Body

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

id
string
Unique event ID. Allows clients to ignore duplicate webhooks.
entityFqdn
string
Fully qualified domain name of the entity associated with the event. Expected
wix.forum.post
.
slug
string
Event name. Expected
reported
.
entityId
string
ID of the entity associated with the event.
eventTime
string
format date-time
.
Event timestamp.
triggeredByAnonymizeRequest
boolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
originatedFrom
string
If present, indicates the action that triggered the event.
actionEvent
object
Event information.
Was this helpful?
Yes
No