Post Object
Attributes
idstringRead-only
Post ID.
categoryIdstring
Category ID the post is listed under.
ownerIdstringRead-only
Post owner's member ID.
titlestringminLength 1maxLength 140
Post title.
contentTextstring
The post content in plain text.
commentCountintegerRead-onlyformat int32
Total number of post comments.
likeCountintegerRead-onlyformat int32
Total number of post likes.
viewCountintegerRead-onlyformat int32
Total number of post views.
createdDatestringRead-onlyformat date-time
Date post was created.
lastActivityDatestringRead-onlyformat date-time
Date of latest activity on this post (e.g., date the latest comment was added to post).
urlobject
Post URL.
slugstringRead-only
Post slug.
bestAnswerCommentIdstringRead-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.
imagesArray <Image>Read-only
Images from post content.
videosArray <VideoV2>Read-only
Videos from post content.
pinnedboolean
Whether the post is pinned. Places the post at the top of the post list.
closedboolean
Whether post is closed and commenting is disabled.
updatedDatestringformat date-time
Date post was updated.
commentInteractionstring
4 supported values:
UNKNOWNREACTIONVOTENONE
Defines what interactions may be applied on the comment under the post, vote or like.
markedCommentsArray <string>Read-onlymaxItems 10
IDs of the marked comments for this post. Posts are marked by the forum admin or the post owner.
recentActivityobject
Recent activity of post. For example, a comment added to a post.
reactionIdentitiesArray <ReactionIdentity>Read-onlymaxItems 6
List of reaction identities grouped by reaction code.
Was this helpful?
GetGet 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?
GetGet 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?
PostQuery 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?
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.
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
idstring
Unique event ID.
Allows clients to ignore duplicate webhooks.
entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.forum.post.
slugstring
Event name. Expected created.
entityIdstring
ID of the entity associated with the event.
eventTimestringformat date-time
Event timestamp.
triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application
(for example, GDPR).
originatedFromstring
If present, indicates the action that triggered the event.
createdEventobject
Event information.
Was this helpful?
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.
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
idstring
Unique event ID.
Allows clients to ignore duplicate webhooks.
entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.forum.post.
slugstring
Event name. Expected updated.
entityIdstring
ID of the entity associated with the event.
eventTimestringformat date-time
Event timestamp.
triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application
(for example, GDPR).
originatedFromstring
If present, indicates the action that triggered the event.
updatedEventobject
Event information.
Was this helpful?
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.
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
idstring
Unique event ID.
Allows clients to ignore duplicate webhooks.
entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.forum.post.
slugstring
Event name. Expected deleted.
entityIdstring
ID of the entity associated with the event.
eventTimestringformat date-time
Event timestamp.
triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application
(for example, GDPR).
originatedFromstring
If present, indicates the action that triggered the event.
deletedEventstruct
Event information.
Was this helpful?
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.
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
idstring
Unique event ID.
Allows clients to ignore duplicate webhooks.
entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.forum.post.
slugstring
Event name. Expected moved.
entityIdstring
ID of the entity associated with the event.
eventTimestringformat date-time
Event timestamp.
triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application
(for example, GDPR).
originatedFromstring
If present, indicates the action that triggered the event.
actionEventobject
Event information.
Was this helpful?
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.
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
idstring
Unique event ID.
Allows clients to ignore duplicate webhooks.
entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.forum.post.
slugstring
Event name. Expected liked.
entityIdstring
ID of the entity associated with the event.
eventTimestringformat date-time
Event timestamp.
triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application
(for example, GDPR).
originatedFromstring
If present, indicates the action that triggered the event.
actionEventobject
Event information.
Was this helpful?
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.
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
idstring
Unique event ID.
Allows clients to ignore duplicate webhooks.
entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.forum.post.
slugstring
Event name. Expected unliked.
entityIdstring
ID of the entity associated with the event.
eventTimestringformat date-time
Event timestamp.
triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application
(for example, GDPR).
originatedFromstring
If present, indicates the action that triggered the event.
actionEventobject
Event information.
Was this helpful?
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.
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
idstring
Unique event ID.
Allows clients to ignore duplicate webhooks.
entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.forum.post.
slugstring
Event name. Expected pinned.
entityIdstring
ID of the entity associated with the event.
eventTimestringformat date-time
Event timestamp.
triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application
(for example, GDPR).
originatedFromstring
If present, indicates the action that triggered the event.
actionEventobject
Event information.
Was this helpful?
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.
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
idstring
Unique event ID.
Allows clients to ignore duplicate webhooks.
entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.forum.post.
slugstring
Event name. Expected unpinned.
entityIdstring
ID of the entity associated with the event.
eventTimestringformat date-time
Event timestamp.
triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application
(for example, GDPR).
originatedFromstring
If present, indicates the action that triggered the event.
actionEventobject
Event information.
Was this helpful?
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.
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
idstring
Unique event ID.
Allows clients to ignore duplicate webhooks.
entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.forum.post.
slugstring
Event name. Expected closed.
entityIdstring
ID of the entity associated with the event.
eventTimestringformat date-time
Event timestamp.
triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application
(for example, GDPR).
originatedFromstring
If present, indicates the action that triggered the event.
actionEventobject
Event information.
Was this helpful?
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.
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
idstring
Unique event ID.
Allows clients to ignore duplicate webhooks.
entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.forum.post.
slugstring
Event name. Expected opened.
entityIdstring
ID of the entity associated with the event.
eventTimestringformat date-time
Event timestamp.
triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application
(for example, GDPR).
originatedFromstring
If present, indicates the action that triggered the event.
actionEventobject
Event information.
Was this helpful?
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.
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
idstring
Unique event ID.
Allows clients to ignore duplicate webhooks.
entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.forum.post.
slugstring
Event name. Expected reported.
entityIdstring
ID of the entity associated with the event.
eventTimestringformat date-time
Event timestamp.
triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application
(for example, GDPR).
originatedFromstring
If present, indicates the action that triggered the event.
actionEventobject
Event information.
Was this helpful?