BookStack

App · 11 actions

Keep your BookStack wiki up to date: publish and update pages from workflows, read a page for an AI step or an email, search the wiki, and add books, chapters and attachments. Start a workflow when a page is added or changed.

Actions

ActionWhat it does
Add attachmentAttach a file, or a link, to a page.
Create bookAdd a book, such as for a new project or client, and put it on a shelf.
Create chapterAdd a chapter to a book, to group its pages.
Create pagePublish a page in a book, or in one of its chapters, such as meeting notes or a report, written in Markdown, HTML or plain text.
Delete page, chapter or bookMove a page, chapter or book to BookStack's recycle bin, where an admin can restore it.
Get pageGet a page's details and what it says, as Markdown, plain text or HTML, such as for an AI step or an email.
List booksList the books, by name, or the books on a shelf.
List pagesList the pages in a book or a chapter, or in every book, most recently updated first.
List shelvesList the shelves, which group books, by name.
SearchFind pages, chapters, books and shelves the way BookStack's search box does, best match first.
Update pageChange a page's content, by replacing it or adding to the end, its title or tags, or move it to another book or chapter.

Add attachment

Attach a file, or a link, to a page. It shows in the page's attachments.

Inputs

PagepagetextRequired
The page's ID (a number, such as 42) from another BookStack step or the trigger, or its link in BookStack.
Filefiletext
The file: upload one, pick one from an earlier step, or give a public https link to download. Leave blank to attach a link.
Linklinktext
A web address to attach as a link instead of a file, such as a shared folder.
Namenametext
What the attachment is called. Defaults to the file's name or the link.

Outputs

created_attext
When it was added (ISO 8601)
extensiontext
The file's extension, such as pdf; empty for a link
idnumber
The attachment's ID
kindtext
file, or link for a link
linktext
Where it opens in BookStack
nametext
The attachment's name
page_idnumber
The ID of the page it's on
Example output
{
  "created_at": "2026-11-05T10:05:00.000000Z",
  "extension": "xlsx",
  "id": 5,
  "kind": "file",
  "link": "https://wiki.example.com/attachments/5",
  "name": "Budget.xlsx",
  "page_id": 42
}

Create book

Add a book, such as for a new project or client, and put it on a shelf.

Inputs

NamenametextRequired
What the book is called.
Descriptiondescriptiontext
What it's about, shown under its name.
Tagstagsobject
Tags, by name, such as {"Client": "Acme"}.
Shelfshelftext
A shelf to put it on. Leave blank for none.

Outputs

created_attext
When it was added (ISO 8601)
descriptiontext
What it's about
idnumber
The book's ID
linktext
Its link in BookStack
nametext
The book's name
shelf_idnumber
The ID of the shelf it was put on; 0 if none
tagsobject
Its tags, by name, such as {"Status": "Draft"}
updated_attext
When it last changed (ISO 8601)
Example output
{
  "created_at": "2026-10-01T09:00:00.000000Z",
  "description": "Notes from every team meeting",
  "id": 7,
  "link": "https://wiki.example.com/books/meeting-notes",
  "name": "Meeting notes",
  "shelf_id": 3,
  "tags": {},
  "updated_at": "2026-11-05T10:00:00.000000Z"
}

Create chapter

Add a chapter to a book, to group its pages.

Inputs

BookbooktextRequired
The book to add it to.
NamenametextRequired
What the chapter is called.
Descriptiondescriptiontext
What it's about, shown under its name.
Tagstagsobject
Tags, by name, such as {"Year": "2026"}.

Outputs

book_idnumber
The ID of the book it's in
book_nametext
The name of the book it's in
created_attext
When it was added (ISO 8601)
descriptiontext
What it's about
idnumber
The chapter's ID
linktext
Its link in BookStack
nametext
The chapter's name
tagsobject
Its tags, by name, such as {"Status": "Draft"}
updated_attext
When it last changed (ISO 8601)
Example output
{
  "book_id": 7,
  "book_name": "Meeting notes",
  "created_at": "2026-01-02T09:00:00.000000Z",
  "description": "This year's meetings",
  "id": 12,
  "link": "https://wiki.example.com/books/meeting-notes/chapter/2026",
  "name": "2026",
  "tags": {},
  "updated_at": "2026-01-02T09:00:00.000000Z"
}

Create page

Publish a page in a book, or in one of its chapters, such as meeting notes or a report, written in Markdown, HTML or plain text.

Inputs

BookbooktextRequired
The book to put the page in.
Chapterchaptertext
The chapter to put it in, in that book. Leave blank to put it in the book itself.
TitlenametextRequired
The page's title.
ContentcontenttextRequired
What the page says, in the format chosen.
Formatcontent_formattext
How the content is written. Defaults to Markdown.One of: markdown, html, plain_text (Plain text). Default: markdown.
Tagstagsobject
Tags to add, by name, such as {"Status": "Draft"}.

Outputs

book_idnumber
The ID of the book it's in
book_nametext
The name of the book it's in
chapter_idnumber
The ID of the chapter it's in; 0 if it isn't in one
created_attext
When it was added (ISO 8601)
created_bytext
Who added it; empty in a list
editortext
The editor it was written in: wysiwyg or markdown
idnumber
The page's ID
linktext
Its permanent link in BookStack, which works after a rename
nametext
The page's title
revision_countnumber
How many times it has been saved
tagsobject
Its tags, by name, such as {"Status": "Draft"}
updated_attext
When it last changed (ISO 8601)
updated_bytext
Who last changed it; empty in a list
Example output
{
  "book_id": 7,
  "book_name": "Meeting notes",
  "chapter_id": 12,
  "created_at": "2026-11-05T10:00:00.000000Z",
  "created_by": "Ada Lovelace",
  "editor": "markdown",
  "id": 42,
  "link": "https://wiki.example.com/link/42",
  "name": "Team meeting, 5 November",
  "revision_count": 1,
  "tags": {
    "Team": "Finance"
  },
  "updated_at": "2026-11-05T10:00:00.000000Z",
  "updated_by": "Ada Lovelace"
}

Delete page, chapter or book

Move a page, chapter or book to BookStack's recycle bin, where an admin can restore it. A chapter or book takes its pages with it.

Inputs

Typeitem_typetextRequired
What it is.One of: page, chapter, book.
Page, chapter or bookitemtextRequired
Its ID from another BookStack step or the trigger, or its link in BookStack.

Outputs

deletedtrue/false
Whether it was moved to the recycle bin
idnumber
Its ID
item_typetext
What it was: page, chapter or book
nametext
Its name or title
Example output
{
  "deleted": true,
  "id": 42,
  "item_type": "page",
  "name": "Team meeting, 5 November"
}

Get page

Get a page's details and what it says, as Markdown, plain text or HTML, such as for an AI step or an email.

Inputs

PagepagetextRequired
The page's ID (a number, such as 42) from another BookStack step or the trigger, or its link in BookStack.
Formatcontent_formattext
How to give the content. Defaults to Markdown.One of: markdown, html, plain_text (Plain text). Default: markdown.

Outputs

book_idnumber
The ID of the book it's in
book_nametext
The name of the book it's in
chapter_idnumber
The ID of the chapter it's in; 0 if it isn't in one
contenttext
What the page says, in the format asked for
created_attext
When it was added (ISO 8601)
created_bytext
Who added it; empty in a list
editortext
The editor it was written in: wysiwyg or markdown
formattext
The content's format: markdown, plain_text or html
idnumber
The page's ID
linktext
Its permanent link in BookStack, which works after a rename
nametext
The page's title
revision_countnumber
How many times it has been saved
tagsobject
Its tags, by name, such as {"Status": "Draft"}
updated_attext
When it last changed (ISO 8601)
updated_bytext
Who last changed it; empty in a list
Example output
{
  "book_id": 7,
  "book_name": "Meeting notes",
  "chapter_id": 12,
  "content": "## Decisions\n\n- Close the books on the 30th",
  "created_at": "2026-11-05T10:00:00.000000Z",
  "created_by": "Ada Lovelace",
  "editor": "markdown",
  "format": "markdown",
  "id": 42,
  "link": "https://wiki.example.com/link/42",
  "name": "Team meeting, 5 November",
  "revision_count": 1,
  "tags": {
    "Team": "Finance"
  },
  "updated_at": "2026-11-05T10:00:00.000000Z",
  "updated_by": "Ada Lovelace"
}

List books

List the books, by name, or the books on a shelf.

Inputs

Shelfshelftext
Only the books on this shelf.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

bookslist
The books
countnumber
How many are listed
totalnumber
How many there are in all
Example output
{
  "books": [
    {
      "created_at": "2026-10-01T09:00:00.000000Z",
      "description": "Notes from every team meeting",
      "id": 7,
      "link": "https://wiki.example.com/books/meeting-notes",
      "name": "Meeting notes",
      "tags": {},
      "updated_at": "2026-11-05T10:00:00.000000Z"
    }
  ],
  "count": 1,
  "total": 1
}

List pages

List the pages in a book or a chapter, or in every book, most recently updated first.

Inputs

Bookbooktext
The book to list. Leave blank for every book.
Chapterchaptertext
Only the pages in this chapter of the book.
Ordersorttext
Which come first. Defaults to recently updated.One of: updated (Recently updated), created (Recently added), name. Default: updated.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
pageslist
The pages
totalnumber
How many there are in all
Example output
{
  "count": 1,
  "pages": [
    {
      "book_id": 7,
      "book_name": "Meeting notes",
      "chapter_id": 12,
      "created_at": "2026-11-05T10:00:00.000000Z",
      "created_by": "Ada Lovelace",
      "editor": "markdown",
      "id": 42,
      "link": "https://wiki.example.com/link/42",
      "name": "Team meeting, 5 November",
      "revision_count": 1,
      "tags": {
        "Team": "Finance"
      },
      "updated_at": "2026-11-05T10:00:00.000000Z",
      "updated_by": "Ada Lovelace"
    }
  ],
  "total": 1
}

List shelves

List the shelves, which group books, by name.

Inputs

How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
shelveslist
The shelves
totalnumber
How many there are in all
Example output
{
  "count": 1,
  "shelves": [
    {
      "created_at": "2026-01-02T09:00:00.000000Z",
      "description": "A book for each team",
      "id": 3,
      "link": "https://wiki.example.com/shelves/teams",
      "name": "Teams",
      "updated_at": "2026-01-02T09:00:00.000000Z"
    }
  ],
  "total": 1
}

Find pages, chapters, books and shelves the way BookStack's search box does, best match first.

Inputs

Search forquerytextRequired
Words to find, as typed in BookStack's search box. Put a phrase in quotes to find it exactly ("leave policy"), a tag in square brackets to find what carries it ([Status=Draft]), and a minus before a word to leave out what has it (-draft).
Look fortypeslist
What to find. Leave blank for everything.One or more of: page (Pages), chapter (Chapters), book (Books), bookshelf (Shelves).
Bookbooktext
Only search inside this book. Leave blank to search everything.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
resultslist
What was found, best match first
totalnumber
How many there are in all
Example output
{
  "count": 1,
  "results": [
    {
      "book_id": 7,
      "book_name": "Meeting notes",
      "chapter_id": 12,
      "chapter_name": "2026",
      "id": 42,
      "link": "https://wiki.example.com/link/42",
      "name": "Team meeting, 5 November",
      "preview": "Close the books on the 30th",
      "tags": {
        "Team": "Finance"
      },
      "type": "page",
      "updated_at": "2026-11-05T10:00:00.000000Z"
    }
  ],
  "total": 1
}

Update page

Change a page's content, by replacing it or adding to the end, its title or tags, or move it to another book or chapter. Fields left blank keep what the page has.

Inputs

PagepagetextRequired
The page's ID (a number, such as 42) from another BookStack step or the trigger, or its link in BookStack.
Titlenametext
A new title. Leave blank to keep it.
Contentcontenttext
The new content, in the format chosen. Leave blank to keep it.
Formatcontent_formattext
How the content is written. Defaults to Markdown.One of: markdown, html, plain_text (Plain text). Default: markdown.
Replace or addmodetext
Whether the content replaces what the page says, or is added to the end of it, such as for a running log.One of: replace (Replace the content), append (Add to the end). Default: replace.
Tagstagsobject
Tags, by name, such as {"Status": "Approved"}. They replace the page's tags. Leave blank to keep them.
Bookbooktext
A book to move the page to. Leave blank to keep it where it is.
Chapterchaptertext
A chapter to move the page to.
Changelogchangelogtext
A short note on what changed, shown in the page's revisions, at most 180 characters.

Outputs

book_idnumber
The ID of the book it's in
book_nametext
The name of the book it's in
chapter_idnumber
The ID of the chapter it's in; 0 if it isn't in one
created_attext
When it was added (ISO 8601)
created_bytext
Who added it; empty in a list
editortext
The editor it was written in: wysiwyg or markdown
idnumber
The page's ID
linktext
Its permanent link in BookStack, which works after a rename
nametext
The page's title
revision_countnumber
How many times it has been saved
tagsobject
Its tags, by name, such as {"Status": "Draft"}
updated_attext
When it last changed (ISO 8601)
updated_bytext
Who last changed it; empty in a list
Example output
{
  "book_id": 7,
  "book_name": "Meeting notes",
  "chapter_id": 12,
  "created_at": "2026-11-05T10:00:00.000000Z",
  "created_by": "Ada Lovelace",
  "editor": "markdown",
  "id": 42,
  "link": "https://wiki.example.com/link/42",
  "name": "Team meeting, 5 November",
  "revision_count": 1,
  "tags": {
    "Team": "Finance"
  },
  "updated_at": "2026-11-05T10:00:00.000000Z",
  "updated_by": "Ada Lovelace"
}

On this page