BookStack icon

BookStack

Consume BookStack API

Overview

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

Common scenarios where this node is beneficial include:

  • Automating content management workflows in BookStack, such as removing outdated or incorrect chapters.
  • Integrating BookStack content lifecycle management into broader automation pipelines.
  • Cleaning up chapters programmatically based on external triggers or conditions.

Practical example:

  • Automatically deleting a chapter when a related project is archived or removed in another system.

Properties

Name Meaning
Tool Description Choose how to determine the resource and operation:
- Set Automatically
- Set Manually
Request Description (Shown only if "Set Automatically" is selected) Describe your request in natural language; the system will infer the resource and operation automatically. Example: "Delete chapter with ID 123".
ID The unique identifier of the chapter 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.

Example output on success:

{}

Example output on failure:

{
  "error": "Chapter not found"
}

Dependencies

  • Requires an API key credential for authenticating with the BookStack API.
  • The base URL of the BookStack instance must be configured in the credentials.
  • The node uses HTTP DELETE requests to the endpoint /api/chapters/{id} to perform the deletion.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent chapter ID will result in an error from the API.
    • Incorrect or missing API credentials will cause authentication failures.
    • Network connectivity issues can prevent the node from reaching the BookStack server.
  • Error messages and resolutions:

    • "Chapter not found": Verify that the chapter ID exists and is correct.
    • Authentication errors: Check that the API token and base URL are correctly set in the credentials.
    • "Request failed" or network errors: Ensure the BookStack server is reachable and the URL is correct.

Links and References

Discussion