> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/helpjuice.md).

# Helpjuice

Create, update, search, and organize Helpjuice knowledge-base content.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Helpjuice | API Key        |

#### Helpjuice

Connect to Helpjuice to create, update, search, and organize knowledge-base content.

**Set up in Helpjuice**

1. Prepare the Helpjuice account or service that the workflow will access. Grant access to the required resources and operations.
2. Create or obtain the API credential identified in the fields below. Use the provider instructions linked with those fields to find its key-management page.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Helpjuice**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field     | Required | What to enter                                                                                                                                                  |
| ----------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Account Subdomain | Yes      | For <https://acme.helpjuice.com>, enter acme.                                                                                                                  |
| API Key           | Yes      | Enable Require token for API and copy the account API key. [Provider instructions](https://help.helpjuice.com/api-v3-webhooks/284079-how-do-i-get-my-api-key). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Helpjuice** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create Article

Create a Helpjuice article as a safe draft or publish it immediately.

**Inputs**

| Field                   | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ----------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Article Title           | string          | Yes      | The title readers will see.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| Main Category           | select (string) | Yes      | The primary category containing the article. Options load from the selected connection.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| Article Body            | textarea        | No       | The article content, including supported HTML formatting.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| Summary                 | textarea        | No       | A short summary of the article.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Publish Now             | boolean         | No       | Publish immediately instead of saving a draft. Default: false.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Visibility              | select (string) | No       | Who can see the article. Available values: Internal, Public, Private. Default: 0.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Additional Category IDs | string          | No       | Other categories where the article should also appear.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| URL Slug                | string          | No       | An optional custom URL slug.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Knowledge Base Language | select (string) | No       | The Helpjuice language for this article translation. Available values: Arabic, Azerbaijani, Belarusian, Bengali, Bosnian, Bulgarian, Burmese, Cantonese, Catalan, Chinese, Chinese (Traditional), Croatian, Czech, Danish, Dari, Dutch, Dutch (Belgium), English (Australia), English (Canada), English (Global), English (India), English (Ireland), English (Middle East), English (Philippines), English (Singapore), English (Tanzania), English (UK), English (US), Estonian, Finnish, French, French (Belgium), French (Canada), French (Swiss), French (Switzerland), Georgian, German, German (Austria), German (Swiss), German (Switzerland), Greek, Hebrew, Hindi, Hungarian, Icelandic, Indonesian, Italian, Japanese, Kazakh, Khmer, Korean, Kurdish, Lao, Latvian, Lithuanian, Malay (Malaysia), Mandarin, Mongolian, Norwegian, Polish, Portuguese, Portuguese (Brazil), Romanian, Russian, Serbian, Slovak, Somali, Spanish, Spanish (Argentina), Spanish (Chile), Spanish (Colombia), Spanish (Mexico), Swedish, Swedish (Finland), Thai, Thai (Thailand), Tigrinya, Turkish, Ukrainian, Urdu, Uzbek, Vietnamese. |

**Outputs**

| Field   | Type   | Description                                   |
| ------- | ------ | --------------------------------------------- |
| Article | object | The structured article returned by Helpjuice. |

#### Update Article

Update a Helpjuice knowledge-base article.

**Inputs**

| Field                   | Type            | Required | Description                                                                              |
| ----------------------- | --------------- | -------- | ---------------------------------------------------------------------------------------- |
| Article ID              | integer         | Yes      | The article to update.                                                                   |
| Title                   | string          | No       | New article title.                                                                       |
| Article Body            | textarea        | No       | New article content.                                                                     |
| Description             | textarea        | No       | New article description.                                                                 |
| Published               | boolean         | No       | Publish or unpublish the article.                                                        |
| Visibility              | select (string) | No       | New Helpjuice visibility setting. Available values: Internal, Public, Private, URL Only. |
| Main Category           | select (string) | No       | New main category for the article. Options load from the selected connection. Default: . |
| Additional Category IDs | string          | No       | Optional comma-separated categories to set with the main category.                       |
| Codename                | string          | No       | New article codename.                                                                    |

**Outputs**

| Field   | Type   | Description          |
| ------- | ------ | -------------------- |
| Article | object | The updated article. |

#### Search Articles

Find articles in your Helpjuice knowledge base.

**Inputs**

| Field        | Type            | Required | Description                                                                            |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------------- |
| Search Query | string          | Yes      | Words to search for in your knowledge-base articles.                                   |
| Category     | select (string) | No       | Optionally search only within one category. Options load from the selected connection. |

**Outputs**

| Field    | Type          | Description                         |
| -------- | ------------- | ----------------------------------- |
| Articles | object\_array | Articles matching the search query. |

#### Get Article

Retrieve one Helpjuice article and its content.

**Inputs**

| Field                   | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ----------------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Article ID              | integer         | Yes      | The article to retrieve.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| Expand Embedded Content | boolean         | No       | Return the final body with internal content blocks expanded. Default: true.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| Knowledge Base Language | select (string) | No       | Prefer a translated article version. Available values: Arabic, Azerbaijani, Belarusian, Bengali, Bosnian, Bulgarian, Burmese, Cantonese, Catalan, Chinese, Chinese (Traditional), Croatian, Czech, Danish, Dari, Dutch, Dutch (Belgium), English (Australia), English (Canada), English (Global), English (India), English (Ireland), English (Middle East), English (Philippines), English (Singapore), English (Tanzania), English (UK), English (US), Estonian, Finnish, French, French (Belgium), French (Canada), French (Swiss), French (Switzerland), Georgian, German, German (Austria), German (Swiss), German (Switzerland), Greek, Hebrew, Hindi, Hungarian, Icelandic, Indonesian, Italian, Japanese, Kazakh, Khmer, Korean, Kurdish, Lao, Latvian, Lithuanian, Malay (Malaysia), Mandarin, Mongolian, Norwegian, Polish, Portuguese, Portuguese (Brazil), Romanian, Russian, Serbian, Slovak, Somali, Spanish, Spanish (Argentina), Spanish (Chile), Spanish (Colombia), Spanish (Mexico), Swedish, Swedish (Finland), Thai, Thai (Thailand), Tigrinya, Turkish, Ukrainian, Urdu, Uzbek, Vietnamese. |

**Outputs**

| Field   | Type   | Description                                      |
| ------- | ------ | ------------------------------------------------ |
| Article | object | The structured article and its content variants. |

#### Create Category

Create an active internal Helpjuice category by default.

**Inputs**

| Field           | Type            | Required | Description                                                                                  |
| --------------- | --------------- | -------- | -------------------------------------------------------------------------------------------- |
| Category Name   | string          | Yes      | The category name readers will see.                                                          |
| Parent Category | select (string) | No       | An optional category that contains this category. Options load from the selected connection. |
| Visibility      | select (string) | No       | Who can see this category. Available values: Internal, Public, Private. Default: 0.          |
| Description     | textarea        | No       | An optional short summary of the category.                                                   |
| URL Slug        | string          | No       | An optional custom URL slug.                                                                 |
| Archived        | boolean         | No       | Keep this category hidden from active use. Default: false.                                   |

**Outputs**

| Field    | Type   | Description                                    |
| -------- | ------ | ---------------------------------------------- |
| Category | object | The structured category returned by Helpjuice. |

#### List Categories

Browse Helpjuice categories and obtain IDs for other actions.

**Inputs**

| Field              | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| ------------------ | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Language           | select (string) | No       | Show categories for one knowledge-base language. Available values: Arabic, Azerbaijani, Belarusian, Bengali, Bosnian, Bulgarian, Burmese, Cantonese, Catalan, Chinese, Chinese (Traditional), Croatian, Czech, Danish, Dari, Dutch, Dutch (Belgium), English (Australia), English (Canada), English (Global), English (India), English (Ireland), English (Middle East), English (Philippines), English (Singapore), English (Tanzania), English (UK), English (US), Estonian, Finnish, French, French (Belgium), French (Canada), French (Swiss), French (Switzerland), Georgian, German, German (Austria), German (Swiss), German (Switzerland), Greek, Hebrew, Hindi, Hungarian, Icelandic, Indonesian, Italian, Japanese, Kazakh, Khmer, Korean, Kurdish, Lao, Latvian, Lithuanian, Malay (Malaysia), Mandarin, Mongolian, Norwegian, Polish, Portuguese, Portuguese (Brazil), Romanian, Russian, Serbian, Slovak, Somali, Spanish, Spanish (Argentina), Spanish (Chile), Spanish (Colombia), Spanish (Mexico), Swedish, Swedish (Finland), Thai, Thai (Thailand), Tigrinya, Turkish, Ukrainian, Urdu, Uzbek, Vietnamese. |
| Maximum Categories | integer         | No       | Stop after collecting approximately this many categories. Minimum: 1. Default: 100.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| Starting Page      | integer         | No       | Resume listing from this Helpjuice page. Minimum: 1. Default: 1.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |

**Outputs**

| Field      | Type          | Description                                                 |
| ---------- | ------------- | ----------------------------------------------------------- |
| Categories | object\_array | Structured Helpjuice categories with their IDs.             |
| Next Page  | integer       | The next Helpjuice page to request, if more results remain. |

#### List Articles

Browse Helpjuice articles using common content and date filters.

**Inputs**

| Field            | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| ---------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Category         | select (string) | No       | Limit articles to one category. Options load from the selected connection.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Created Since    | string          | No       | Only include articles created on or after this date.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| Updated Since    | string          | No       | Only include articles updated on or after this date.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| Updated Through  | string          | No       | Only include articles updated through this date.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| Visibility       | select (string) | No       | Limit articles by visibility. Available values: Internal, Public, Private.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Published State  | boolean         | No       | Show only published articles or only drafts.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Language         | select (string) | No       | Limit articles to one language. Available values: Arabic, Azerbaijani, Belarusian, Bengali, Bosnian, Bulgarian, Burmese, Cantonese, Catalan, Chinese, Chinese (Traditional), Croatian, Czech, Danish, Dari, Dutch, Dutch (Belgium), English (Australia), English (Canada), English (Global), English (India), English (Ireland), English (Middle East), English (Philippines), English (Singapore), English (Tanzania), English (UK), English (US), Estonian, Finnish, French, French (Belgium), French (Canada), French (Swiss), French (Switzerland), Georgian, German, German (Austria), German (Swiss), German (Switzerland), Greek, Hebrew, Hindi, Hungarian, Icelandic, Indonesian, Italian, Japanese, Kazakh, Khmer, Korean, Kurdish, Lao, Latvian, Lithuanian, Malay (Malaysia), Mandarin, Mongolian, Norwegian, Polish, Portuguese, Portuguese (Brazil), Romanian, Russian, Serbian, Slovak, Somali, Spanish, Spanish (Argentina), Spanish (Chile), Spanish (Colombia), Spanish (Mexico), Swedish, Swedish (Finland), Thai, Thai (Thailand), Tigrinya, Turkish, Ukrainian, Urdu, Uzbek, Vietnamese. |
| Maximum Articles | integer         | No       | Stop after collecting approximately this many articles. Minimum: 1. Default: 100.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| Starting Page    | integer         | No       | Resume listing from this Helpjuice page. Minimum: 1. Default: 1.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |

**Outputs**

| Field     | Type          | Description                                                 |
| --------- | ------------- | ----------------------------------------------------------- |
| Articles  | object\_array | Structured Helpjuice article summaries with IDs.            |
| Next Page | integer       | The next Helpjuice page to request, if more results remain. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/helpjuice.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
