Category Object

Properties
idstringRead-only

Category ID.


parentIdstring

Category parent ID.


namestringminLength 1maxLength 35

Category name.


headerTitlestringmaxLength 35

Category header title.


headerTypestring
3 enum supported values:
NONECOLORIMAGE

Category header type.


headerImageobject

Category header image.


rankintegerRead-onlyformat int32

Category rank (display order).


postCountintegerRead-onlyformat int32

Total number of posts in category.


postViewCountintegerRead-onlyformat int32

Total number of post views in category.


slugstringRead-only

Category slug.


urlobject

Category URL.


descriptionstringmaxLength 140

Category description.


postTypesArray <string>

List of post type that Category supports. Deprecated on '2021-08-03'.


createdDatestringRead-onlyformat date-time

Date category was created.


categoryAccessstringRead-only
4 enum supported values:
UNKNOWNPUBLICMEMBERS_ONLYPRIVATE

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.


updatedDatestringformat date-time

Date category was updated.


noMemberPostingboolean

Whether only admins and moderators can write posts in category.


groupsArray <string>Read-only

Ids of groups which can access category if categoryAccess is PRIVATE.


commentInteractionstring
4 enum supported values:
UNKNOWNREACTIONVOTENONE

Defines what interactions may be applied on the comment under the posts created in this category, vote or like.


mainCommentReactionobject

Defines which icon will be used for the main reaction on the comment under the posts created in this category.

Default type: "LIKE".


additionalCommentReactionsArray <Reaction>maxItems 5

Defines what additional reactions may be applied on the comment under the posts created in this category.


postInteractionstring
3 enum supported values:
UNKNOWNREACTIONNONE

Defines what interactions may be applied on the posts created in this category, like or multiple reactions.


mainPostReactionobject

Defines which icon will be used for main reaction on the posts created in this category.

Default type: "LIKE".


additionalPostReactionsArray <Reaction>maxItems 5

Defines what additional reactions may be applied on the posts created in this category.

Was this helpful?
Yes
No

GetGet 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.
Was this helpful?
Yes
No

GetGet 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.
Was this helpful?
Yes
No

PostQuery 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.
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.

Event BodyEvent 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.category.


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?
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.

Event BodyEvent 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.category.


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?
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.

Event BodyEvent 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.category.


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?
Yes
No