BookStack icon

BookStack

Manage BookStack resources
Join our community

Actions22

Overview

This node integrates with the BookStack platform, allowing users to manage various BookStack resources such as books, pages, shelves, and chapters. Specifically, the Get Book operation retrieves detailed information about a single book by its unique identifier.

Common scenarios for this node include:

  • Fetching metadata or details of a specific book in BookStack for display or further processing.
  • Automating workflows that require retrieving book information before performing updates or generating reports.
  • Integrating BookStack content into other systems by extracting book data dynamically.

Example use case: A user wants to retrieve the details of a book with ID "123" to display its name, description, and tags in another application or to verify its existence before updating it.

Properties

Name Meaning
Book ID The unique identifier of the book to retrieve. Example: "123". This is a required field.

Output

The output is a JSON object representing the retrieved book's data. It typically includes fields such as:

  • id: The book's unique identifier.
  • name: The name/title of the book.
  • description: A textual description of the book.
  • tags: An array of tag objects associated with the book.
  • Other metadata fields supported by BookStack for books (e.g., default template ID).

The output structure directly reflects the BookStack API response for a single book resource.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to a BookStack instance via an API key credential configured in n8n.
  • The node uses HTTP requests to the BookStack REST API endpoints.
  • Proper permissions on the BookStack API are necessary to perform read operations on books.

Troubleshooting

  • Error: "Book not found" or similar
    Ensure the provided Book ID exists in the BookStack instance and that the API credentials have permission to access it.

  • Authentication errors
    Verify that the API key credential is correctly configured and has sufficient rights.

  • Network or timeout issues
    Check network connectivity to the BookStack server and confirm the server is reachable.

  • Invalid input errors
    Make sure the Book ID is provided and is a valid string matching an existing book.

Links and References

Discussion