About the FAQ APIs

The FAQ APIs allow you to programmatically manage FAQ content on Wix sites. You can manage frequently asked questions, their categorization, and their labels for use with chat bots and other apps. These features let you integrate FAQ management into external apps, and manage content across multiple sites. You can use the FAQ APIs to integrate FAQ management into external apps, manage content across multiple sites, and organize questions for chatbots and help desk systems.

The FAQ APIs provide functionality for:

• Category management: Create and organize FAQ questions by topic. Categories are the themed groupings that structure FAQ content and appear as sections in FAQ widgets on a site, allowing visitors to browse questions by topic.
• Question and answer management: Create and manage individual FAQ content items. Question entries support 3 answer formats to accommodate different content needs:
  • Draft.js for structured rich text with complex formatting.
  • Rich Content for advanced layouts with media and interactive elements.
  • Plain text for simple answers without special formatting.

Before you begin

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

• The Wix user must install the FAQ app on their site.
• Question entries must belong to categories, and deleting a category also deletes its question entries.

Use cases

• Build an FAQ section.
• Reorganize FAQ content.
• Integrate FAQ content with external systems.

Terminology

• Question entries: Individual FAQ content items, containing a question and its answer. The questions and answers appear on Wix FAQ widgets on a site.
• Categories: Themed groupings that organize question entries. For example, Shipping or Returns. Categories appear as sections in Wix FAQ widgets on a site, allowing visitors to browse questions by topic.
• Labels: Additional groupings of FAQ question entries. Labels aren't visible to site visitors, but are useful for organizing content for external integrations like chatbots, mobile apps, or help desk systems. A question can belong to a single category but up to 100 labels.

Wix multilingual integration

The FAQ app includes built-in integration with Wix Multilingual. When a site has both the FAQ app and Wix Multilingual installed, the FAQ app automatically sends FAQ content to Wix Multilingual when categories or question entries are created, allowing Wix users to translate FAQ content.

On list and query requests, the FAQ APIs automatically retrieve translated content from Wix Multilingual and merge it into the response. Wix Multilingual resolves the language from the language and locale settings in Multilingual or a site's defaults.

If you install Wix Multilingual after the FAQ app, the FAQ app automatically sends all FAQ content to Wix Multilingual for localization.

The FAQ APIs let you programmatically create and organize FAQ categories and question entries, and integrate FAQ content with external systems like chatbots and help desks. For more details and examples, see the Integrate FAQ content with external systems flow.