Product Fruits

https://help.productfruits.com/
Admin
Product Fruits is a user engagement platform offering onboarding guides, in-app messaging,...
Tokens:129,312
Snippets:1,969
Trust Score:9.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### REST API GET Request Example

Source: https://help.productfruits.com/en/article/actions

Demonstrates a GET request using a variable for the authorization token.

```bash
curl -X GET "https://api.example.com/v1/customers?limit=10" \
  -H "Authorization: Bearer {{user.props.apiToken}}" \
  -H "Accept: application/json"
```

--------------------------------

### List Knowledge Base Articles Examples

Source: https://help.productfruits.com/en/article/knowledge-base-api-list-articles-endpoint

Examples showing how to filter articles by category or retrieve all articles.

```http
GET /articles
```

```http
GET /articles?correlationCategoryId=tutorials
```

```http
GET /articles?correlationCategoryId=null
```

--------------------------------

### Example Response for Get All Categories

Source: https://help.productfruits.com/en/article/knowledge-base-api-list-categories

A sample response body for a successful category retrieval request.

```json
{
  "categories": [
    {
      "id": 1,
      "correlationId": "documentation",
      "parentCategoryId": null,
      "order": 1,
      "isFeatured": true,
      "icon": "image-guid-123",
      "contents": [
        {
          "lang": "en",
          "title": "Documentation",
          "description": "Complete documentation and guides",
          "slug": "docs",
          "slug_state": "manual"
        }
      ]
    }
  ]
}
```

--------------------------------

### Install Product Fruits for Vue 3

Source: https://help.productfruits.com/en/article/developers-installation-to-vuejs

Use this command to install the Product Fruits package via npm for Vue 3 applications.

```bash
npm install product-fruits
```

--------------------------------

### Get All Categories via cURL

Source: https://help.productfruits.com/en/article/knowledge-base-api-list-categories

Example request using cURL to fetch the category list.

```bash
curl -X GET "https://api.productfruits.com/v1/knowledgebase/categories" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
```

--------------------------------

### Error Handling Example

Source: https://help.productfruits.com/en/article/knowledge-base-api-delete-category

Example of a 400 Bad Request response when attempting to delete a category that still contains articles.

```bash
curl -X DELETE "https://api.productfruits.com/v1/knowledgebase/categories/category-with-articles" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
```

```json
{
  "error": "Category contains articles. Use articleHandling=move-to-root to move articles to root or remove articles first"
}
```

--------------------------------

### Error Handling Example

Source: https://help.productfruits.com/en/article/knowledge-base-api-delete-article--by-language-endpoint

Demonstrates the response received when attempting to delete content that does not exist.

```bash
# Attempt to delete content that doesn't exist
curl -X DELETE "https://api.productfruits.com/v1/knowledgebase/articles/getting-started-001/content/zh" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
```

```json
{
  "error": "Article with correlation ID 'getting-started-001' not found"
}
```

--------------------------------

### Version selection behavior example

Source: https://help.productfruits.com/en/article/knowledge-base-api-import-articles-endpoint

Demonstrates how the API automatically selects the published version for updates when available.

```json
// Scenario: Article has 3 content versions for language "en"
// Version 1: Created 2024-01-01, Unpublished (draft)
// Version 2: Created 2024-01-15, Unpublished (draft)  
// Version 3: Created 2024-01-10, Published ✅ (only one can be published per language)

// This update will modify Version 3 (the published version) ✅
{
  "correlationId": "article-001",
  "contents": [
    {
      "lang": "en",
      "title": "Updated Title",
      "createNewVersion": false    // Updates Version 3 (published version)
    }
  ]
}

// If no published versions exist, falls back to most recent
// All drafts scenario: Version A (2024-01-01, Draft), Version B (2024-01-15, Draft)
// Result: Would update Version B (most recent draft)
```

--------------------------------

### Auto-Generated Slug Example

Source: https://help.productfruits.com/en/article/knowledge-base-api-import-articles-endpoint

Demonstrates the default behavior where a slug is generated from the article title when no slug is provided.

```json
// Creating new content - slug auto-generated from title
{
  "lang": "en",
  "title": "Getting Started Guide",     // → slug: "getting-started-guide" (auto-generated)
  "content": "...",
  "format": "markdown"
  // No slug provided, so auto-generated
}

// More examples:
// "FAQ & Troubleshooting" → slug: "faq-troubleshooting"  
// "User Management (Admin)" → slug: "user-management-admin"
```

--------------------------------

### Error Handling Example

Source: https://help.productfruits.com/en/article/knowledge-base-api-import-categories

Demonstrates a 400 Bad Request response when required fields like title are missing.

```curl
curl -X POST "https://api.productfruits.com/knowledgebase/v1/categories/import" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "categories": [
      {
        "id": -1,
        "contents": [
          {
            "lang": "en",
            "slug": "docs",
            "slug_state": "manual"
          }
        ]
      }
    ]
  }'
```

--------------------------------

### Initialize Product Fruits

Source: https://help.productfruits.com/en/article/installation-via-npm-package

Import the library and initialize it with your workspace code, language, and user information. Ensure this runs only once after user authentication.

```javascript
import { productFruits } from 'product-fruits';

// later in the code
productFruits.init('<<YOUR WORKSPACE CODE>>', '<<LANGUAGE CODE>>', { username: '<<REPLACE>>' });
```

--------------------------------

### Initialize Product Fruits

Source: https://help.productfruits.com/en/article/developers-installation-to-other-web-environments

Call the init action with your workspace code, language code, and user information object once the user is logged in.

```javascript
<script type="text/javascript">
	$productFruits.push(['init', 'WORKSPACE CODE', 'LANGUAGE CODE', { username: '<<REPLACE>>' }]);
</script>
```

--------------------------------

### Retrieve Article Content Request

Source: https://help.productfruits.com/en/article/get-knowledge-base-article-content

Example of a GET request to fetch article content in Markdown format.

```http
GET /v1/knowledge-base/articles/rich-md-fixture/content/en?format=markdown
```

--------------------------------

### productFruits.init()

Source: https://help.productfruits.com/en/article/installation-via-npm-package

Initializes the Product Fruits library with configuration options, including the ability to disable automatic location change detection for SPAs.

```APIDOC
## productFruits.init(workspaceCode, languageCode, userObject, options)

### Description
Initializes the Product Fruits instance. Use the `disableLocationChangeDetection` option if automatic route detection fails in your SPA.

### Parameters
- **workspaceCode** (string) - Required - Your unique workspace identifier.
- **languageCode** (string) - Required - The language code for the tour.
- **userObject** (object) - Required - Object containing user identification details (e.g., username).
- **options** (object) - Optional - Configuration object. Set `disableLocationChangeDetection: true` to handle route changes manually.

### Request Example
productFruits.init(
	'<<YOUR WORKSPACE CODE>>', 
	'<<LANGUAGE CODE>>', 
	{ 
		username: '<<REPLACE>>' 
	},
	{
		disableLocationChangeDetection: true
	}
);
```

--------------------------------

### GET /categories

Source: https://help.productfruits.com/en/article/knowledge-base-api-quickstart

Get all categories from the knowledge base.

```APIDOC
## GET /categories

### Description
Get all categories from the knowledge base.

### Method
GET

### Endpoint
api.productfruits.com/v1/knowledgebase/categories
```

--------------------------------

### Tawk.to Integration Example

Source: https://help.productfruits.com/en/article/custom-chat-widget-integration

Complete implementation for integrating Tawk.to, including event listeners for chat state changes and script loading.

```html
<!--Start of Tawk.to Script-->
<script type="text/javascript">

var Tawk_API=Tawk_API||{}, Tawk_LoadStart=new Date();

           // Hide Product Fruits when Tawk.to chat is maximized 
window.Tawk_API.onChatMaximized = function () {
        if (window.productFruits.api.inAppCenter.isOpened()) {
          window.productFruits.api.inAppCenter.close();
        }
      };

      // Show Product Fruits when Tawk.to chat is minimized
      window.Tawk_API.onChatMinimized = function () {
        $productFruits.push([
	'do',
	'toggle-elvin-widget', 
	{ 
	}
]);
      };

      // Initially hide the Tawk.to widget when it loads
      window.Tawk_API.onLoad = function () {
        window.Tawk_API.hideWidget();
      };

      // Event listener for Life Ring Button chat button to open custom chat widget
      window.addEventListener("productfruits_button_ext_widget_init", () => {
        window.Tawk_API.maximize();
      });

// TAWKTO JAVASCRIPT SNIPPET
(function(){
var s1=document.createElement("script"),s0=document.getElementsByTagName("script")[0];
s1.async=true;
s1.src='https://embed.tawk.to/xxxxxxxxxxxxxxx/xxxxxxx';
s1.charset='UTF-8';
s1.setAttribute('crossorigin','*');
s0.parentNode.insertBefore(s1,s0);
})();
</script>
<!--End of Tawk.to Script-->
```

--------------------------------

### Initialization Options

Source: https://help.productfruits.com/en/article/custom-initialization-options

Configuration options available during the Product Fruits initialization process.

```APIDOC
## Initialization Options

### Description
Options passed during the init action to control SDK behavior.

### Parameters
- **disableLocationChangeDetection** (boolean) - Optional - Set to true to turn off automatic URL change detection.
- **disableBannersAutoMargin** (boolean) - Optional - Set to true to prevent automatic layout adjustments when banners are displayed.
- **hideInAppCenterLauncher** (boolean) - Optional - Set to true to hide the built-in Life Ring Button launcher.
- **hideElvinLauncher** (boolean) - Optional - Set to true to hide the Elvin launcher button.
- **customNavigation** (object) - Optional - Enables and handles custom routing.

#### customNavigation Properties
- **use** (boolean) - Required - Set to true to enable custom routing.
- **navigate** (function) - Required - Callback function called by Product Fruits to navigate to a URL.
- **onGet** (function) - Required - Callback function called by Product Fruits to retrieve the current URL.
```

--------------------------------

### Override CSS Variables Example

Source: https://help.productfruits.com/en/article/easy-to-adjust-css-variables

Example of how to apply a custom value to a CSS variable using the container root selector.

```css
.productfruits--container-root {
    --card-border-radius: 15px;
}
```

--------------------------------

### Import Multilingual Articles with Configuration

Source: https://help.productfruits.com/en/article/knowledge-base-api-import-articles-endpoint

Use these examples to import articles with multiple language contents and specific import configurations.

```json
{
  "articles": [
    {
      "correlationId": "advanced-guide-001",
      "categoryCorrelationId": "advanced",
      "isFeatured": true,
      "featuredOrder": 1,
      "contents": [
        {
          "correlationId": "content-en-advanced",
          "lang": "en",
          "title": "Advanced Features Guide",
          "content": "# Advanced Features\n\nExplore powerful advanced capabilities...",
          "format": "markdown",
          "publishStatus": "published"
        },
        {
          "correlationId": "content-es-advanced",
          "lang": "es",
          "title": "Guía de Funciones Avanzadas",
          "content": "# Funciones Avanzadas\n\nExplora las potentes funciones avanzadas...",
          "format": "markdown",
          "publishStatus": "published"
        }
      ]
    }
  ],
  "config": {
    "slugConflictHandling": "auto-number",
    "ignoreImportErrors": false,
    "includeContentInResponse": true
  }
}
```

```bash
curl -X POST "https://api.productfruits.com/v1/knowledgebase/import" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "articles": [
      {
        "correlationId": "advanced-guide-001",
        "categoryCorrelationId": "advanced",
        "isFeatured": true,
        "featuredOrder": 1,
        "contents": [
          {
            "correlationId": "content-en-advanced",
            "lang": "en",
            "title": "Advanced Features Guide",
            "content": "# Advanced Features\\n\\nExplore powerful advanced capabilities...",
            "format": "markdown",
            "publishStatus": "published"
          },
          {
            "correlationId": "content-es-advanced",
            "lang": "es",
            "title": "Guía de Funciones Avanzadas",
            "content": "# Funciones Avanzadas\\n\\nExplora las potentes funciones avanzadas...",
            "format": "markdown",
            "publishStatus": "published"
          }
        ]
      }
    ],
    "config": {
      "slugConflictHandling": "auto-number",
      "ignoreImportErrors": false,
      "includeContentInResponse": true
    }
  }'
```

--------------------------------

### Delete Article Content Examples

Source: https://help.productfruits.com/en/article/knowledge-base-api-delete-article--by-language-endpoint

Examples demonstrating how to delete specific language content using cURL, including English and Spanish variants.

```bash
curl -X DELETE "https://api.productfruits.com/v1/knowledgebase/articles/getting-started-001/content/en" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
```

```bash
curl -X DELETE "https://api.productfruits.com/v1/knowledgebase/articles/pf_123/content/es" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
```

--------------------------------

### Product Fruits GTM installation script

Source: https://help.productfruits.com/en/article/google-tag-manager-installation

This script initializes Product Fruits. Replace 'XXXXXX' with your workspace code and update the language code as needed.

```html
<!-- 1. Insert this part to HEAD -->
<script type="text/javascript">
(function(w, d, u) {
	w.$productFruits = w.$productFruits || [];
	w.productFruits = w.productFruits || {};
	w.productFruits.scrV = '2';
	
	var a = d.getElementsByTagName('head')[0];
	var r = d.createElement('script');
	r.async = 1;
	r.src = u;
	a.appendChild(r);
})(window, document, 'https://app.productfruits.com/static/script.js');

/*
 * Please note the following about the below push snippet:
 * 1. The XXXXX must be replaced with your workspace code, 
 *    find it in the 'installation' tab of your Product Fruits workspace.
 *
 * 2. The language code here is set to 'en' for English, but if your 
 *    onboarding content is in another language, this should be adjusted.
 *    If onboarding content is blank after installation, then check 
 *    your workspace settings to see which language your content was written in.
 *
 * 3. 'username' should be set to the identity of the
 *	current user (not your Product Fruits username). 
 *	More information about a user can be sent. Check our documentation 
 *	for more information.
 */

$productFruits.push(['init', 'XXXXXX', 'en', { username: '<<REPLACE>>' }]);
</script>
```

--------------------------------

### Full Proxy Configuration and Script Loading

Source: https://help.productfruits.com/en/article/extending-initialization-with-proxy-and-jsendpoint

A complete implementation including the custom script loader and the initialization queue with proxy settings.

```html
<!-- Script to load Product Fruits from custom proxy -->
<script type="text/javascript">
    (function(w, d, u) {
        w.$productFruits = w.$productFruits || [];
        w.productFruits = w.productFruits || {};
        w.productFruits.scrV = '2';
        let a = d.getElementsByTagName('head')[0];
        let r = d.createElement('script');
        r.async = 1;
        r.src = u;
        a.appendChild(r);
    })(window, document, 'https://YOUR_CUSTOM_PROXY_DOMAIN.com/static/script.js');
</script>

<!-- Initialize Product Fruits via queue -->
<script type="text/javascript">
    $productFruits.push([
        'init',
        '<<YOUR WORKSPACE CODE>>',
        '<<LANGUAGE CODE>>',
        {
            username: '<<REPLACE>>'
        },
        {
            proxy: {
                jsEndpoint: "https://YOUR_CUSTOM_PROXY_DOMAIN.com",
                appEndpoint: "https://YOUR_CUSTOM_PROXY_DOMAIN.com",
                wsEndpoint: "wss://YOUR_CUSTOM_PROXY_DOMAIN.com/ws2",
                eventsEndpoint: "https://YOUR_CUSTOM_PROXY_DOMAIN.com/clickstream",
                kbEndpoint: "https://YOUR_CUSTOM_PROXY_DOMAIN.com/help"
            }
        }
    ]);
</script>
```

--------------------------------

### Start the current tour

Source: https://help.productfruits.com/en/article/custom-javascript-triggers

Attempts to start the tour associated with the current trigger. The force parameter allows overriding previous completion or skip states.

```javascript
this.tryStartThisTour(force)
```

--------------------------------

### tryStartTour(tourId)

Source: https://help.productfruits.com/en/article/javascript-api-product-tours

Attempts to start a specific tour by its ID.

```APIDOC
## productFruits.api.tours.tryStartTour(tourId)

### Description
Starts a tour by the given ID. The user state is reset to `not_finished`. Note that tour rules and segmentations are still evaluated.

### Parameters
- **tourId** (number) - Required - The ID of the tour to start.
```

--------------------------------

### Initialize Custom Routing with NPM

Source: https://help.productfruits.com/en/article/custom-routing

Configure custom navigation during the productFruits.init call to handle internal and external URL routing.

```javascript
import { productFruits } from 'product-fruits';

productFruits.init(
    '<<workspacecode>>',
    '<<languagecode>>',
    { username: '<<replace>>' },
    {
        customNavigation: {
            use: true, // Enables custom routing
            navigate: (url) => {
                // Handle navigation using your custom router
                if (/^https?:\/\//.test(url)) {
					window.location.href;
                } else {
                    // Use your app's router for internal URLs
                    yourCustomRouter.navigate(url);
                }
            },
            onGet() {
                // Return the current URL (must start with https://)
                return window.location.href; 
                // Example: 'https://example.com/current-route'
            },
        }
    }
);
```

--------------------------------

### Get Announcement by ID

Source: https://help.productfruits.com/en/article/announcement-management-api

Retrieve details of a specific announcement by its unique identifier.

```APIDOC
## GET /v1/{type}/{announcementId}

### Description
Retrieves the details of a specific announcement using its unique UUID.

### Method
GET

### Endpoint
/v1/{type}/{announcementId}

### Parameters
#### Path Parameters
- **type** (string) - Required - The resource type: banners, newsfeeds, or popups.
- **announcementId** (string) - Required - The unique UUID of the announcement.
```

--------------------------------

### Listen to the productfruits_ready event

Source: https://help.productfruits.com/en/article/javascript-api-overview

Attach an event listener to the window object to execute code once the library is ready. Ensure the handler is attached before the Product Fruits snippet is executed.

```javascript
window.addEventListener('productfruits_ready', function() { 
    console.log('Product Fruits is ready!');
});

// here comes the Product Fruits snippet
```

--------------------------------

### Initialize Product Fruits with hidden default launcher

Source: https://help.productfruits.com/en/article/custom-launcher-for-the-life-ring-button

Set the hideInAppCenterLauncher option to true during initialization to prevent the default launcher from appearing.

```javascript
$productFruits.push([
        "init",
        "WORKSPACE_CODE",
        "LANGUAGE_CODE",
        {
          username: "USERNAME",
        },
        { hideInAppCenterLauncher : true }
      ]);
```

--------------------------------

### Start a survey manually

Source: https://help.productfruits.com/en/article/using-the-surveys-api

Initiates a survey programmatically using its unique identifier.

```javascript
window.productFruits.api.surveys.startSurvey('XXX-XXX-XXX-XXX')
```

--------------------------------

### GET /categories/{correlationId}

Source: https://help.productfruits.com/en/article/knowledge-base-api-get-specific-category

Retrieves the details of a specific category identified by its correlation ID.

```APIDOC
## GET /categories/{correlationId}

### Description
Retrieves the details of a specific category using its unique correlation ID. This is useful for validating category existence, checking properties, or analyzing hierarchy relationships.

### Method
GET

### Endpoint
/categories/{correlationId}

### Parameters
#### Path Parameters
- **correlationId** (string) - Required - The unique identifier for the category (custom ID or "pf_" + internal ID).

### Response
#### Success Response (200)
- **category** (object) - The category object containing properties such as hierarchy, slug, and localization status.

#### Error Response (400)
- **error** (string) - "Correlation ID is required"

#### Error Response (401)
- **error** (string) - "Authentication required or invalid API token"

#### Error Response (404)
- **error** (string) - "Category with correlation ID 'invalid-id' not found"

#### Error Response (500)
- **error** (string) - "Internal server error occurred while retrieving category"
```

--------------------------------

### Initialize Product Fruits with Proxy Configuration

Source: https://help.productfruits.com/en/article/extending-initialization-with-proxy-and-jsendpoint

Use the proxy object within the init call to override default endpoints for JavaScript chunks, application data, and web sockets.

```html
<script type="text/javascript">
	$productFruits.push([
	    'init',
	    '<<YOUR WORKSPACE CODE>>', 
	    '<<LANGUAGE CODE>>', 
	    { 
	        username: '<<REPLACE>>' 
	    },
	    {
	        proxy: { 
	            jsEndpoint: "https://YOUR_CUSTOM_PROXY_DOMAIN.com",  // Custom domain for JS chunks
	            appEndpoint: "https://YOUR_CUSTOM_PROXY_DOMAIN.com",
	            wsEndpoint: "wss://YOUR_CUSTOM_PROXY_DOMAIN.com/ws2",
	            eventsEndpoint: "https://YOUR_CUSTOM_PROXY_DOMAIN.com/clickstream",
	            kbEndpoint: "https://YOUR_CUSTOM_PROXY_DOMAIN.com/help"
	        }
	    }
	]);
</script>
```

--------------------------------

### GET /v1/knowledgebase/categories/{id}

Source: https://help.productfruits.com/en/article/knowledge-base-api-get-specific-category

Retrieves the details of a specific knowledge base category by its identifier.

```APIDOC
## GET /v1/knowledgebase/categories/{id}

### Description
Retrieves the details of a specific knowledge base category using either its custom correlation ID or its internal ID.

### Method
GET

### Endpoint
https://api.productfruits.com/v1/knowledgebase/categories/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The custom correlation ID or internal ID of the category.

### Request Example
curl -X GET "https://api.productfruits.com/v1/knowledgebase/categories/docs-category" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

### Response
#### Success Response (200)
- **id** (integer) - The internal ID of the category.
- **correlationId** (string) - The custom correlation ID.
- **parentCategoryId** (integer|null) - The ID of the parent category if applicable.
- **order** (integer) - The display order of the category.
- **isFeatured** (boolean) - Whether the category is featured.
- **icon** (string) - The icon identifier.
- **contents** (array) - List of localized content objects.

#### Response Example
{
  "id": 123,
  "correlationId": "docs-category",
  "parentCategoryId": null,
  "order": 1,
  "isFeatured": true,
  "icon": "image-guid-123",
  "contents": [
    {
      "lang": "en",
      "title": "Documentation",
      "description": "Complete documentation and guides",
      "slug": "docs",
      "slug_state": "manual"
    }
  ]
}
```

--------------------------------

### Define the window.productFruitsReady callback

Source: https://help.productfruits.com/en/article/javascript-api-overview

Assign a function to window.productFruitsReady to be executed upon initialization. This must be defined before the Product Fruits snippet is loaded.

```javascript
window.productFruitsReady = function() {
    console.log('Product Fruits is ready!');
};

// here comes the Product Fruits snippet
```

--------------------------------

### GET /v1/knowledgebase/categories

Source: https://help.productfruits.com/en/article/knowledge-base-api-list-categories

Retrieve a list of all categories in the knowledge base with their content in different languages.

```APIDOC
## GET /v1/knowledgebase/categories

### Description
Retrieve a list of all categories in the knowledge base with their content in different languages. This endpoint is useful for understanding the current category structure, synchronization, and preparing for category imports.

### Method
GET

### Endpoint
/v1/knowledgebase/categories

### Request Headers
- **Authorization** (string) - Required - Bearer YOUR_API_TOKEN

### Response
#### Success Response (200)
- **categories** (array) - List of category objects

#### Response Example
{
  "categories": [
    {
      "id": 123,
      "correlationId": "docs-category",
      "parentCategoryId": null,
      "order": 1,
      "isFeatured": true,
      "icon": "image-guid-123",
      "contents": [
        {
          "lang": "en",
          "title": "Documentation",
          "description": "All documentation and guides",
          "slug": "docs",
          "slug_state": "manual"
        }
      ]
    }
  ]
}
```

--------------------------------

### Install Product Fruits React package

Source: https://help.productfruits.com/en/article/developers-integration-react-nextjs

Use npm to add the Product Fruits React wrapper to your project dependencies.

```bash
npm install react-product-fruits --save
```

--------------------------------

### GET /kb/articles/{articleId}/content

Source: https://help.productfruits.com/en/article/get-knowledge-base-article-content

Retrieves the content of a specific knowledge base article.

```APIDOC
## GET /kb/articles/{articleId}/content

### Description
Retrieves the content of a knowledge base article. You can specify the output format as either HTML or Markdown.

### Method
GET

### Endpoint
/kb/articles/{articleId}/content

### Parameters
#### Path Parameters
- **articleId** (string) - Required - The unique identifier of the article.

#### Query Parameters
- **correlationId** (string) - Required - Identifier for the request.
- **lang** (string) - Required - The language code for the article content.
- **format** (string) - Optional - The desired output format. Use 'html' for HTML or 'markdown' for Markdown.

### Response
#### Success Response (200)
- **content** (string) - The article content.
- **conversionResults** (object) - Details regarding the conversion process (relevant for markdown format).

### Error Responses
- **400**: Missing `correlationId` or `lang`.
- **401**: Missing or invalid authentication token.
- **404**: Article not found, or content for the requested language does not exist.
```

--------------------------------

### Handle API Errors

Source: https://help.productfruits.com/en/article/knowledge-base-api-update-specific-category

Example of an error response when attempting to update a non-existent category.

```bash
curl -X PUT "https://api.productfruits.com/v1/knowledgebase/categories/non-existent-category" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "isFeatured": true
  }'
```

```json
{
  "error": "Category with correlation ID 'non-existent-category' not found"
}
```

--------------------------------

### Initialize Product Fruits with HMAC

Source: https://help.productfruits.com/en/article/user-identity-verification

Pass the generated HMAC hash and optional expiration date to the productFruits.init method during frontend initialization.

```javascript
import { productFruits } from 'product-fruits'

// the Product Fruits user object
const userInfoWithHMAC = {
    username: username,
    hmac: { // this is important
        hash: hmacHash, // hmacHash is the code you generated in your backend, not the private key!
        expiration: expirationFinalDate // if you use the expiration feature, pass the final datetime
    },
    props: {
    	// custom user props can be passed here
    }
};

productFruits.init('<<YOUR WORKSPACE CODE>>', '<<LANGUAGE CODE>>', userInfoWithHMAC);
```

--------------------------------

### Integrate HubSpot Chat with Product Fruits

Source: https://help.productfruits.com/en/article/hubspot-chat

This example includes the HTML structure for the chat container, CSS for styling, and the JavaScript required to initialize the HubSpot chat and handle visibility toggling via Product Fruits events.

```html
<!-- Define the HubSpot chat panel root element. This element will be holding the HubSpot chat frame -->
<div id="hubspot-chat-holder" style="position: fixed; right: 30px; bottom: 30px; background-color: white; visibility: hidden">
    
	<button onclick="onHubspotClosed()">Close</button>
    
	<!-- This element will be holding the HubSpot chat -->
    <div id="hubspot-chat" style="height: 500px; width: 300px;">
    </div>
</div>
<!-- Add some styles. This enlarges the HubSpot chat itself. -->
    
<style>
    #hubspot-conversations-inline-iframe {
        width: 300px;
        height: 500px;
        border:none;
    }
</style>
    
<!-- This is HubSpot configuration object. It tells HubSpot to embed the chat to the #hubspot-chat element (we created it above) -->
<script>
	window.hsConversationsSettings = {
    	loadImmediately: true,
    	inlineEmbedSelector: '#hubspot-chat'
    };
    
    
	// This code handles the Custom Chat provider settings. See the Custom Provider section in our help docs.
    const hubspotHolder = document.getElementById('hubspot-chat-holder');
    window.addEventListener('productfruits_button_ext_widget_init', () => {
       	hubspotHolder.style.visibility = ''; // if we get signal from PF Life Ring button, show the HubSpot element
    });
    
    
/* This method is called by the Close button, it hides the HubSpot element and shows the Life Ring button again */
    function onHubspotClosed() {
       	hubspotHolder.style.visibility = 'hidden';
       	window.productFruits.api.inAppCenter.show();
    }
</script>
    
    
<!-- This part is about getting a notification, when the HubSpot chat is closed and the user will get a message -->
<script type="text/javascript">
   	function onConversationsAPIReady() {
       	window.HubSpotConversations.on('unreadConversationCountChanged', payload => {
   			if (payload.unreadCount > 0) {
   				// You should notify the user about the new chat, if the popup with the chat is closed.
   				// For instance, you can show another element.
   			}
   		});
   	}

   	if (window.HubSpotConversations) {
   		onConversationsAPIReady();
   	} else {
		window.hsConversationsOnReady = [onConversationsAPIReady];
   	}
</script>
    
<!-- Start of HubSpot Embed Code -->
<script type="text/javascript" id="hs-script-loader" async defer src="//js-eu1.hs-scripts.com/XXXXXX.js"></script>
<!-- End of HubSpot Embed Code -->
```

--------------------------------

### Delete Content Response Examples

Source: https://help.productfruits.com/en/article/knowledge-base-api-delete-article--by-language-endpoint

JSON responses returned after executing deletion requests.

```json
{
  "message": "Article content for language 'en' deleted successfully"
}
```

```json
{
  "message": "Article content for language 'es' deleted successfully"
}
```

--------------------------------

### GET /v1/knowledgebase/categories

Source: https://help.productfruits.com/en/article/knowledge-base-api-import-categories

Retrieves the current list of knowledge base categories to facilitate the load-modify-import workflow.

```APIDOC
## GET /v1/knowledgebase/categories

### Description
Retrieves all existing knowledge base categories. This is the recommended first step in the load-modify-import workflow.

### Method
GET

### Endpoint
https://api.productfruits.com/v1/knowledgebase/categories
```

--------------------------------

### REST API POST Request Example

Source: https://help.productfruits.com/en/article/actions

Demonstrates a POST request with a JSON body containing injected user variables.

```bash
curl -X POST "https://api.example.com/v1/customers" \
  -H "Authorization: Bearer {{user.props.apiToken}}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "{{user.name}}",
    "email": "{{user.email}}"
  }'
```

--------------------------------

### GET /categories/{correlationId}

Source: https://help.productfruits.com/en/article/knowledge-base-api-get-specific-category

Retrieves the details of a specific category based on the provided correlation ID.

```APIDOC
## GET /categories/{correlationId}

### Description
Retrieves a specific category from the knowledge base using its unique correlation ID.

### Method
GET

### Endpoint
/categories/{correlationId}

### Parameters
#### Path Parameters
- **correlationId** (string) - Required - The unique identifier for the category, which can be a custom correlation ID or an internal ID.
```

--------------------------------

### productFruits.api.inAppCenter.open(opts)

Source: https://help.productfruits.com/en/article/javascript-api-life-ring-button-v2

Expands the Life Ring Button. Optionally accepts an options object to focus on a specific article.

```APIDOC
## productFruits.api.inAppCenter.open(opts)

### Description
Expands the Life Ring Button. It can receive an options object to focus on a specific article.

### Parameters
- **opts** (object) - Optional - Configuration object
  - **focus** (object) - Optional - Focus settings
    - **articleId** (number) - Optional - The ID of the article to focus on

### Example
```javascript
window.productFruits.api.inAppCenter.open({
	focus: { 
		articleId: 12345
	}
})
```
```

--------------------------------

### GET /v1/knowledgebase/articles

Source: https://help.productfruits.com/en/article/knowledge-base-api-list-articles-endpoint

Retrieves a list of articles from the knowledge base. Supports filtering by category ID.

```APIDOC
## GET /v1/knowledgebase/articles

### Description
Retrieves a list of articles from the knowledge base. You can optionally filter the results by providing a category ID or retrieve root articles by setting the category ID to null.

### Method
GET

### Endpoint
https://api.productfruits.com/v1/knowledgebase/articles

### Parameters
#### Query Parameters
- **correlationCategoryId** (string) - Optional - The ID of the category to filter articles by. Use 'null' to retrieve root articles.

### Response
#### Success Response (200)
- **articles** (array) - A list of article objects.

#### Response Example
{
  "articles": [
    {
      "id": "1",
      "correlationId": "getting-started",
      "lastModified": "2024-01-15T10:30:00Z",
      "categoryId": 1,
      "isPrivate": false,
      "isHidden": false,
      "isFeatured": true,
      "featuredOrder": 1,
      "order": 1,
      "version": "v1",
      "alternateSlugs": null,
      "contents": [
        {
          "id": "1",
          "correlationId": "getting-started-en",
          "lang": "en",
          "published": true,
          "lastModified": "2024-01-15T10:30:00Z"
        }
      ]
    }
  ]
}
```

--------------------------------

### Request Format Error Responses

Source: https://help.productfruits.com/en/article/knowledge-base-api-import-articles-endpoint

Examples of errors caused by missing or malformed request bodies.

```json
{
  "error": "Body not present"
}
```

```json
{
  "error": "Invalid request body - malformed JSON"
}
```
Tokens:
Raw