BookStack icon

BookStack

Manage BookStack resources
Join our community

Actions22

Overview

This node integrates with the BookStack platform to manage its resources such as books, pages, shelves, and chapters. Specifically, for the Book - Update operation, it allows users to update existing book records by specifying the book's unique identifier and any fields they want to modify.

Typical use cases include:

  • Updating metadata of a book like its name, description, tags, or default page template.
  • Automating content management workflows where book details need to be programmatically changed based on external triggers or data sources.
  • Synchronizing book information from other systems into BookStack.

For example, you might update a book’s description and tags after receiving new editorial input or change the default template used for pages within that book.

Properties

Name Meaning
Book ID The unique identifier of the book to update (e.g., "123"). Required to specify which book to update.
Name The new name/title of the book (maximum 255 characters).
Description A textual description of the book (maximum 1900 characters).
Default Template ID The ID of the default template to apply to pages within this book.
Tags Comma-separated list of tags associated with the book.

Output

The node outputs JSON objects representing the updated book resource as returned by the BookStack API. This typically includes all the book’s properties after the update, such as its ID, name, description, tags (as an array of tag objects), and default template ID.

No binary data output is produced by this operation.

Dependencies

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

Troubleshooting

  • Missing or invalid Book ID: The update operation requires a valid book ID. If omitted or incorrect, the API will return an error indicating the resource was not found.
  • Invalid field values: Fields like name and description have maximum length constraints. Exceeding these may cause API validation errors.
  • API authentication errors: Ensure the API key credential is correctly set up and has sufficient permissions.
  • Network or connectivity issues: Failures to reach the BookStack server will result in request errors.
  • Empty update payload: If no fields besides the ID are provided, the API might reject the request or make no changes.

To resolve errors, verify the input parameters, check API credentials, and confirm network access to the BookStack instance.

Links and References

Discussion