Discuss Kit icon

Discuss Kit

Consume Discuss Kit API

Overview

The node integrates with the Discuss Kit API to manage various content types such as discussions, blogs, bookmarks, documentation, boards, labels, comments, and search queries. Specifically for the Documentation resource with the Update Content operation, it updates existing documentation content by modifying fields like title, content, board association, labels, assignees, parent content, and display order.

This node is beneficial in scenarios where automated or programmatic updates to documentation content are needed within a collaborative platform. For example, it can be used to update technical documents, manuals, or knowledge base articles dynamically based on external triggers or workflows.

Practical examples:

  • Automatically updating a product manual's content when new information becomes available.
  • Changing the display order of documentation pages to reflect a new structure.
  • Assigning team members to specific documentation pages for review or editing.

Properties

Name Meaning
Title The title of the documentation content to update.
Content The main body content of the documentation, provided as a JSON string.
Board The ID of the board to which this documentation belongs, organizing content into groups.
Labels Comma-separated list of labels/tags associated with the documentation for categorization.
Assignees Comma-separated list of decentralized identifiers (DIDs) representing users assigned to the doc.
Content ID The unique identifier of the documentation content to update (required).
Slug A URL-friendly string identifier for the documentation content, often used in links.
Parent ID The ID of the parent documentation content, enabling hierarchical structuring.
Display Order Numeric value indicating the order in which the documentation appears relative to siblings.

Output

The node outputs a JSON object representing the updated documentation content as returned by the Discuss Kit API. This typically includes all updated fields such as title, content, boardId, labels, assignees, slug, parentId, order, and metadata like creation and modification timestamps.

No binary data output is involved in this operation.

Dependencies

  • Requires access to the Discuss Kit API endpoint.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • Uses internal helper functions to make HTTP requests to the Discuss Kit API.
  • No additional external services beyond the Discuss Kit API are required.

Troubleshooting

  • Common issues:

    • Invalid or missing Content ID will cause the update request to fail.
    • Incorrect formatting of comma-separated fields (labels, assignees) may lead to unexpected behavior.
    • Insufficient permissions or invalid API credentials will result in authorization errors.
    • Providing invalid values for numeric fields like Display Order could cause API validation errors.
  • Error messages and resolutions:

    • "Content ID is required": Ensure the Content ID property is set and valid.
    • "Unauthorized" or "Authentication failed": Verify that the API key credential is correctly configured and has necessary permissions.
    • "Invalid input" or "Validation error": Check that all required fields are properly formatted and meet API requirements.
    • Network timeouts or connectivity issues: Confirm network access to the Discuss Kit API endpoint.

Links and References

Discussion