BookStack icon

BookStack

Consume BookStack API

Actions31

Overview

This node integrates with the BookStack API to manage book-related resources programmatically. Specifically, for the Book - Create operation, it allows users to create a new book resource within their BookStack instance by providing essential details such as the book's name and optionally its description.

Common scenarios where this node is beneficial include:

  • Automating the creation of documentation books in BookStack as part of a CI/CD pipeline.
  • Bulk importing or generating books from external data sources.
  • Integrating BookStack content creation into broader workflows involving knowledge management or content publishing.

For example, a user could automate creating a new book titled "Project Documentation" with a brief description, triggered whenever a new project is initialized in their system.

Properties

Name Meaning
Name The name/title of the book to be created.
Description (Optional) A textual description of the book, providing additional context or summary.

Output

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

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to a BookStack instance via its API.
  • Needs an API authentication token credential configured in n8n that provides:
    • Base URL of the BookStack API.
    • Token ID and Token Secret for authorization.
  • The node sends HTTP POST requests to the /books endpoint of the BookStack API.

Troubleshooting

  • Missing Required Fields: If the "Name" property is not provided, the API will reject the request. Ensure the "Name" field is filled.
  • Authentication Errors: Invalid or missing API tokens will cause authorization failures. Verify that the API credentials are correctly set up and have sufficient permissions.
  • Invalid Base URL: Incorrect API base URL configuration can lead to connection errors. Confirm the base URL points to your BookStack instance's API endpoint.
  • API Rate Limits or Quotas: Excessive requests might be throttled by the BookStack server; consider adding delays or handling retries.
  • Data Type Issues: The node converts some IDs to integers internally; ensure numeric values are valid if extending usage beyond the book resource.

Links and References

Discussion