Wix Answers Help Center

Procedures

Finding an Article ID

An article ID (GUID) references a specific article, including all translated versions of an article. The ID is useful if you are linking from a product that is translated into many languages, and you need a way to keep track of all articles related to your product. Article IDs are necessary when working with article APIs.To find an article ID: Go to the live URL of the relevant article. Click the Toolbar Expand Tab at the top left. Note: To see this option, make sure you are logged in as a team member. Click Manage this article in the Team Member Toolbar. The article ID appears in the article URL following 'article': For example: https://[your-subdomain-name].wixanswers.com/app/hc/article/article-id/

Finding a Category ID

A category ID (GUID) references a specific knowledge base category, including all translated versions of it. You can get category IDs from the URLs in your Wix Answers account's Categories page.To find a category ID: Hover over the Knowledge Base icon and click Categories. Select the relevant category on the left.  The category ID appears in the URL following 'categories': For example: https://[your-subdomain-name].wixanswers.com/app/kb/categories/2cbc3ca3-9e77-45ef-a4a0-c37bdd66267dNote:To find a subcategory's ID, select the subcategory in step 2 above, then locate the ID at the end of the URL after the parent category's ID (view image below). 

Finding a Custom Field Name

Wix Answers generates a name for each custom field that you define. You need this name to, for example, create a new ticket using that custom field. To find these names, navigate in the Wix Answers UI to Settings > Custom Fields > Edit (of specific custom field).

Authenticating Users With the Widget

Use an authenticated widget if:You want to embed a widget in your site that contains knowledge base articles that only logged-in users can access.You want logged-in users to be able to contact you with their identity verified.OverviewTo authenticate a user, the client code that embeds the widget on your site must request a token for this user from your server. Your server verifies the identity of the user through whichever method you currently use and then requests a token for this user from our auth REST API. This request is secured using your Wix Answers Api Key and Api Secret. When your client code receives the token it is passed to the Widget using an SDK method.In accordance with web security best practices, the token that our auth API provides is short lived and is only valid for 5 minutes. Therefore, rather than passing a single token to the widget, you must supply a function to the widget that returns a promise that resolves to the token. The Widget gets a new token whenever necessary.Code exampleYou can find an example of the server endpoint that you must implement here. The example is for a node server using express and axios.You can find an example of the change you must make to your widget embed code in order to add the authentication function here. The example uses axios.

Working With Custom Fields

Wix Answers makes it straightforward to create custom fields and then create or update items, such as tickets or users, with values for these fields. If you configured any automatic actions for tickets, they can be run based on the values in your tickets' custom fields, either when the ticket is created or when the custom fields change. In addition, you can filter items based on their custom field values.The steps to work with custom fields are:Create a custom field.Copy the custom field's auto-generated name; you will need it when setting or reading the field's value using the API.Create a ticket, user, agent, or company while passing the customFields parameter with the auto-generated field name and the field value, or update the custom fields of a ticket or user. Note that an agent's custom fields are different from, and in addition to, the agent's user custom fields.The payload for this includes the following line (example):{ ... "customFields": { "dept-1": "development", "office": "Seattle" } ... }See the relevant API methods in the Tickets API (Add Ticket, Update a Ticket's Custom Fields), Users API (Add User, Update a User's Custom Fields), Agents API, and Company API pages.Note: If You Intend to Configure Custom Fields Using a Webhook After Adding the TicketIf you create a ticket, and then update custom fields in a ticket by calling an API using the webhook, you may want the webhook to rerun the automatic actions after setting the custom fields in the webhook. See Update Custom Fields in a Ticket.