OutlineInstall

Overview

This node integrates with the Outline knowledge base API, allowing users to perform various operations on different resources such as documents, collections, groups, comments, attachments, and more. Specifically for the Document - Update operation, it updates an existing document's title and/or content in markdown format.

Common scenarios where this node is beneficial include:

• Automating updates to documentation stored in Outline.
• Synchronizing content changes from other systems into Outline documents.
• Programmatically managing knowledge base content without manual editing.

For example, you can use this node to update a document’s title or markdown content after processing data elsewhere in your workflow, ensuring your knowledge base stays current automatically.

Properties

Note: Although the provided properties JSON only includes documentId and text (Content), the code also optionally supports updating the document's title if provided.

Output

The node outputs the response from the Outline API after performing the update operation. The output is a JSON object representing the updated document details as returned by the API.

The structure typically includes fields like document ID, title, content, timestamps, and other metadata depending on the Outline API response.

No binary data output is produced by this operation.

Dependencies

• Requires an API key credential for authenticating with the Outline API.
• The node uses HTTP POST requests to communicate with the Outline API endpoints.
• No additional external dependencies are required beyond the configured API authentication.

Troubleshooting

• Missing or invalid Document ID: The update will fail if the Document ID is not provided or incorrect. Ensure the ID corresponds to an existing document.
• Empty content or title: If neither title nor content is provided for update, the API may reject the request or make no changes. Provide at least one field to update.
• API authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
• Network or API errors: Handle transient network issues by enabling "Continue On Fail" in n8n or retrying the workflow.

Common error messages:

• "Document not found": Check the Document ID.
• "Unauthorized" or "Invalid API key": Check API credentials.
• "Validation failed": Ensure input fields meet API requirements.

Links and References

• Outline API Documentation (for detailed API endpoint info)
• Markdown Guide (to format document content)

If you need details on other operations or resources, feel free to ask!