BookStack icon

BookStack

Consume BookStack API

Actions40

Overview

This node integrates with the BookStack API, allowing users to manage various BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically for the Chapter - Delete operation, it enables deleting a chapter resource by its ID.

Common scenarios where this node is beneficial include automating content management workflows in BookStack, such as removing outdated or incorrect chapters programmatically without manual intervention through the BookStack UI.

Practical example: Automatically delete a chapter when a related project is archived or removed in another system, keeping your documentation clean and up-to-date.

Properties

Name Meaning
Tool Description Choose how to determine the resource and operation:
- Set Automatically
- Set Manually
Request Description (Shown if "Set Automatically" is selected) Describe what you want to do in natural language; the system tries to detect the resource and operation automatically. Example: "Delete chapter with ID 123".
ID The unique identifier of the chapter resource to delete. Required for delete operation.

Output

The node outputs JSON data representing the response from the BookStack API after attempting to delete the chapter. Typically, this will be an empty object or confirmation message indicating successful deletion.

If an error occurs, the output JSON will contain an error field with the error message.

No binary data output is produced by this operation.

Dependencies

  • Requires connection to a BookStack instance via its API.
  • Needs an API authentication token credential configured in n8n with:
    • Base URL of the BookStack API.
    • Token and token secret for authorization.
  • The node uses HTTP DELETE requests to the endpoint /api/chapters/{id}.

Troubleshooting

  • Common issues:

    • Invalid or missing chapter ID: Ensure the ID property is correctly set and corresponds to an existing chapter.
    • Authentication errors: Verify that the API token and base URL credentials are correct and have sufficient permissions.
    • Network or connectivity problems: Confirm that the BookStack server is reachable from the n8n environment.

  • Error messages:

    • "error": "Resource not found": The specified chapter ID does not exist. Double-check the ID.
    • "error": "Unauthorized" or similar: Authentication failed. Check API credentials.
    • Other HTTP errors may indicate permission issues or server errors; consult BookStack API documentation for details.

Links and References

Discussion