BookStack icon

BookStack

Consume BookStack API

Actions31

Overview

This node integrates with the BookStack API to manage content resources such as books, pages, chapters, and shelves. Specifically, for the Chapter - Create operation, it allows users to create a new chapter within a specified book by providing essential details like the chapter's name and the associated book ID.

Common scenarios where this node is beneficial include:

  • Automating the creation of structured documentation or knowledge bases.
  • Programmatically adding chapters to books in bulk or via workflows.
  • Integrating BookStack content management into larger automation pipelines.

For example, a user could automate the generation of chapters based on external data sources, ensuring that each chapter is correctly linked to its parent book.

Properties

Name Meaning
Name The name/title of the chapter to be created.
Book ID The identifier of the book to which this chapter belongs. This links the chapter to its parent book.

Output

The node outputs JSON data representing the newly created chapter resource as returned by the BookStack API. This typically includes fields such as the chapter's ID, name, book association, and other metadata provided by the API response.

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.
  • Network access to the BookStack API endpoint is necessary.

Troubleshooting

  • Missing Required Fields: If "Name" or "Book ID" are not provided, the API will likely reject the request. Ensure these required properties are set.
  • Invalid Book ID: Providing a non-existent or incorrect book ID will cause the API to fail creating the chapter. Verify the book ID before use.
  • Authentication Errors: Incorrect or missing API credentials will result in authorization errors. Confirm that the API token and base URL are correctly configured.
  • API Endpoint Issues: Network problems or incorrect base URLs can cause connection failures. Check connectivity and configuration.
  • Data Type Mismatch: The node converts the "Book ID" from string to integer before sending. Supplying non-numeric values may cause errors.

Links and References

Discussion