BookStackInstall

Overview

This node integrates with the BookStack API to manage various BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically for the Page resource with the Copy operation, it allows duplicating an existing page by its ID.

The node supports two modes of operation:

• Automatic mode: You provide a natural language description of your request (e.g., "Copy the page titled 'API Documentation'"), and the node attempts to parse and determine the appropriate resource and operation automatically.
• Manual mode: You explicitly select the resource ("Page") and operation ("Copy") and provide required parameters like the page ID.

Typical use cases include:

• Quickly duplicating a page within BookStack to create a similar page without manually copying content.
• Automating content management workflows where pages need to be replicated programmatically.
• Using natural language descriptions to simplify API interactions without needing to know exact API details.

Properties

For the Copy operation on the Page resource, additional properties (not shown in the provided JSON but inferred from code) include:

Output

The node outputs JSON data representing the response from the BookStack API after performing the copy operation. This typically includes the details of the newly created copied page, such as its ID, name, content, and metadata.

If the operation fails, and the node is configured to continue on failure, the output will contain an error message describing the issue.

No binary data output is involved in this operation.

Dependencies

• Requires an API key credential for authenticating with the BookStack API.
• The node expects the base URL of the BookStack instance and authentication tokens to be configured in the credentials.
• The BookStack API must be accessible from the environment where n8n runs.

Troubleshooting

• Common issues:

  • Providing an invalid or missing page ID will cause the copy operation to fail.
  • Incorrect or expired API credentials will result in authentication errors.
  • Network connectivity problems to the BookStack server can cause request failures.

• Error messages:

  • Errors returned from the BookStack API are passed through in the output JSON under an error field if "Continue On Fail" is enabled.
  • Authentication errors typically indicate invalid or missing API tokens; verify credentials configuration.
  • If the node cannot parse the natural language request in automatic mode, it may default to a different operation or resource, leading to unexpected results.

• Resolution tips:

  • Ensure the page ID is correct and exists in the BookStack instance.
  • Verify API credentials and permissions.
  • Use manual mode if automatic detection does not correctly interpret your request.

Links and References

• BookStack Official API Documentation
• n8n Documentation on Creating Custom Nodes
• BookStack GitHub Repository