BookStack

Overview

This node integrates with the BookStack API to manage book-related resources such as books, pages, chapters, and shelves. Specifically for the Create operation on the Book resource, it allows users to create a new book in their BookStack instance either by manually specifying details or by describing the request in natural language for automatic interpretation.

Common scenarios where this node is beneficial include:

• Automating documentation workflows by programmatically adding new books.
• Integrating content management systems with BookStack to keep documentation up-to-date.
• Quickly creating structured knowledge bases from external triggers or inputs.

For example, a user can describe a request like "Create a new book about API documentation," and the node will automatically parse this description to create a book with an appropriate name and description.

Properties

Output

The node outputs JSON data representing the response from the BookStack API after creating the book. This typically includes details of the newly created book such as its ID, name, description, creation timestamps, and other metadata returned by the API.

No binary data output is produced by this node.

Example output structure (simplified):

{
  "id": 123,
  "name": "API Documentation",
  "description": "Created automatically based on request: \"Create a new book about API documentation\"",
  "created_at": "2024-01-01T12:00:00Z",
  "updated_at": "2024-01-01T12:00:00Z",
  ...
}

Dependencies

• Requires access to a BookStack instance with API enabled.
• Needs an API authentication token credential configured in n8n to authorize requests.
• The base URL and tokens must be set in the node credentials for the BookStack API.

Troubleshooting

• Common issues:

  • Invalid or missing API credentials will cause authentication failures.
  • Incorrect base URL configuration may lead to connection errors.
  • Missing required fields like "Name" when creating a book manually will result in validation errors.
  • If using automatic mode, ambiguous or unclear request descriptions might not correctly map to the intended resource or operation.

• Error messages:

  • Authentication errors usually indicate invalid or expired tokens; verify and update credentials.
  • HTTP 404 errors suggest incorrect URLs or resource IDs.
  • Validation errors from the API indicate missing or malformed input properties; ensure all required fields are provided.

Links and References

• BookStack API Documentation
• n8n Documentation on Creating Custom Nodes