About the Comment Context API

The Comment Context API resolves what the current identity, a site visitor or a site member, is allowed to do with comments in a specific context, such as a Wix Blog post or a Wix Comments category.

With the Comment Context API, you can:

• Retrieve the resolved comment permissions for the current identity in a given context.
• Retrieve the site's registration data, to render guest-comment and join-community flows.

Resolved permissions

Unlike category permissionsSettings, which describe the configured policy, Get Comment Context returns the resolved result for the caller: it accounts for the identity's roles, including site owner and moderator overrides. Use it to decide which commenting UI to render. For example, whether to show the comment box, reply, vote, react, or report actions.

Registration data

When the request fields include REGISTRATION_DATA, the response also carries the site's registration data (registrationData): whether new member signups require owner approval and whether email verification is required. This lets you render guest-comment and join-community flows without a separate call. Request it only when you need it, because it is resolved from a separate service.

Before you begin

It's important to note the following points before starting to code:

• The appId, contextId, and contextType triple identifies the context. See Integrations in the Comments introduction for the values each Wix app uses.
• Permissions are resolved per identity. Call this API with the same visitor or member authentication you use for the rest of the comments flow.
• registrationData is best effort: when the site's sign-on policy can't be resolved, the field is omitted.

Use cases

• Render a comments UI that matches the caller's permissions

Terminology

• Context: The place on a site where comments live, identified by appId, contextId, and contextType. For example, a Wix Blog post or a Wix Comments category.
• Resolved permissions: The final set of comment actions the current identity may perform in a context, after applying category settings and the identity's roles, including owner and moderator overrides.
• Registration data: The site's sign-on policy flags that affect commenting, such as whether new member signups require owner approval.