BookStack

Overview

This node integrates with the BookStack API, allowing users to manage BookStack resources such as books, pages, chapters, and shelves. Specifically, the Update Book operation lets you modify an existing book's details by specifying its ID and new properties like name and description.

Common scenarios include:

• Updating the title or description of a book in your documentation system.
• Automating content management workflows where book metadata needs periodic updates.
• Integrating BookStack with other tools to keep documentation synchronized.

Example: You have a book titled "API Guide" and want to update its name to "API Reference" and add a description explaining its contents. This node can perform that update via the BookStack API.

Properties

Output

The node outputs JSON data representing the updated book resource as returned by the BookStack API. This typically includes fields such as the book's ID, name, description, creation and update timestamps, and other metadata.

No binary data output is produced by this node.

Example output snippet (simplified):

{
  "id": 123,
  "name": "Updated Book Name",
  "description": "Updated description text",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-02-01T15:30:00Z"
}

Dependencies

• Requires connection to a BookStack instance with valid API credentials (an API token and secret).
• The node expects the base URL of the BookStack API and authentication tokens configured in n8n credentials.
• HTTP requests are made to the BookStack REST API endpoints.

Troubleshooting

• Missing or invalid ID: The update operation requires a valid book ID. Ensure the ID is correct and corresponds to an existing book.
• Authentication errors: If the API token or base URL is incorrect or expired, requests will fail. Verify credentials in n8n settings.
• Validation errors: Providing empty or invalid values for required fields like name may cause the API to reject the request.
• Network issues: Connectivity problems to the BookStack server will result in request failures.
• Automatic detection inaccuracies: When using automatic mode with a free-text request description, the node attempts to infer the resource and operation. Ambiguous or unclear descriptions might lead to unexpected behavior.

To resolve errors:

• Double-check all input parameters.
• Confirm API credentials and permissions.
• Use manual mode if automatic detection does not work as expected.

Links and References

• BookStack API Documentation
• BookStack Official Website
• n8n Documentation on Creating Custom Nodes