Actions22
Overview
This node integrates with BookStack, a platform for creating and managing documentation and knowledge bases. Specifically, the "Page" resource with the "Create" operation allows users to create new pages within books or chapters in BookStack. This is useful for automating content creation workflows, such as programmatically adding documentation pages from other systems or templates.
Typical use cases include:
- Automatically generating documentation pages from external data sources.
- Creating structured content inside specific books or chapters based on user input or events.
- Managing large sets of pages by batch creation through automation.
For example, you could use this node to create a new page named "API Reference" inside a particular book or chapter, providing either HTML or Markdown content, and tagging it for easy categorization.
Properties
| Name | Meaning |
|---|---|
| Name | The name/title of the page (max 255 characters). |
| Book ID | The identifier of the book to which this page belongs. Required if Chapter ID is not provided. |
| Chapter ID | The identifier of the chapter to which this page belongs. Required if Book ID is not provided. |
| HTML Content | The HTML content of the page. Required if Markdown Content is not provided. |
| Markdown Content | The Markdown content of the page. Required if HTML Content is not provided. |
| Tags | Comma-separated list of tags to assign to the page for categorization. |
Output
The node outputs JSON objects representing the created page(s) as returned by the BookStack API. Each output item corresponds to one created page and includes all properties returned by the API, such as page ID, name, content, associated book/chapter IDs, tags, and metadata.
The node does not output binary data.
Dependencies
- Requires an API key credential for authenticating with the BookStack API.
- The node uses HTTP requests to communicate with the BookStack REST API endpoints.
- No additional external dependencies beyond the configured API authentication are needed.
Troubleshooting
- Missing Book ID or Chapter ID: When creating a page, either a Book ID or a Chapter ID must be provided. If both are missing, the node will throw an error indicating that one of these identifiers is required.
- Missing Content: Either HTML content or Markdown content must be supplied when creating a page. Omitting both will cause an error.
- Invalid Tags Format: Tags should be provided as a comma-separated string. Improper formatting may lead to unexpected behavior.
- API Errors: Any errors returned by the BookStack API (e.g., invalid credentials, permission issues, or invalid parameters) will be surfaced as node execution errors with the API message included.
- Character Limits: The page name has a maximum length of 255 characters; exceeding this may cause API rejection.
To resolve errors:
- Ensure all required fields are filled correctly.
- Verify API credentials and permissions.
- Check the format of tags and content fields.
- Review error messages for specific API feedback.