Category Object

Attributes

id
string
READ ONLY
Category ID.
parentId
string
Category parent ID.
name
string
minLength 1
,
maxLength 35
.
Category name.
headerTitle
string
maxLength 35
.
Category header title.
headerType
string
3 supported values:

NONE, COLOR, IMAGE,

Category header type.
headerImage
object
Category header image.
rank
integer
READ ONLY
format int32
.
Category rank (display order).
postCount
integer
READ ONLY
format int32
.
Total number of posts in category.
postViewCount
integer
READ ONLY
format int32
.
Total number of post views in category.
slug
string
READ ONLY
Category slug.
url
object
Category URL.
description
string
maxLength 140
.
Category description.
postTypes
Array <string>
List of post type that Category supports. Deprecated on '2021-08-03'.
createdDate
string
READ ONLY
format date-time
.
Date category was created.
categoryAccess
string
READ ONLY
4 supported values:

UNKNOWN, PUBLIC, MEMBERS_ONLY, PRIVATE,

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.
updatedDate
string
format date-time
.
Date category was updated.
noMemberPosting
boolean
Whether only admins and moderators can write posts in category.
groups
Array <string>
READ ONLY
Ids of groups which can access category if categoryAccess is PRIVATE.
commentInteraction
string
4 supported values:

UNKNOWN, REACTION, VOTE, NONE,

Defines what interactions may be applied on the comment under the posts created in this category, vote or like.
mainCommentReaction
object
Defines which icon will be used for main reaction (like) on the comment under the posts created in this category.
additionalCommentReactions
Array <Reaction>
maxItems 5
.
Defines what additional reactions may be applied on the comment under the posts created in this category.
postInteraction
string
3 supported values:

UNKNOWN, REACTION, NONE,

Defines what interactions may be applied on the posts created in this category, like or multiple reactions.
mainPostReaction
object
Defines which icon will be used for main reaction (like) on the posts created in this category.
additionalPostReactions
Array <Reaction>
maxItems 5
.
Defines what additional reactions may be applied on the posts created in this category.
Was this helpful?
Yes
No
get

Get Category

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 single category 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 Category 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.

Returns a single category 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 Categories

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 categories by query

Paging

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

Filterable fields:

  • id
  • parentId
  • name
  • rank
  • headerTitle
  • headerType
  • headerDescription
  • postCount
  • postViewCount
  • slug

Sortable fields:

  • rank
  • postCount
  • postViewCount

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

Category 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 category 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.category
.
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

Category 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 category 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.category
.
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

Category 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 category 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.category
.
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