Skip to main content
HackMD logo
  • Category: documents
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 8
  • Triggers: 0
  • Slug: HACKMD
  • Version: 00000000_00

Tools

Slug: HACKMD_CREATE_NOTECreate a Markdown note in the personal workspace or a specified team workspace. The team branch is documented but was not live-tested because the test account belongs to no teams.

Input Parameters

array
Tags to assign to the note.
string
Note title.
string
Initial note body as Markdown. Content creation was live-verified; later content replacement is intentionally unavailable.
string
Team path from HACKMD_GET_ACCOUNT. Omit for the personal workspace; team creation was not live-verified.
string
Short note description.
string ("owner" | "signed_in" | "guest")
Who may read the note; omit to use HackMD’s default.
string
Folder ID from HACKMD_LIST_FOLDERS in the selected workspace.
string ("owner" | "signed_in" | "guest")
Who may edit the note; omit to use HackMD’s default.
string ("disabled" | "forbidden" | "owners" | "signed_in_users" | "everyone")
Who may comment; omit to use HackMD’s default.
string ("disabled" | "forbidden" | "owners" | "signed_in_users")
Who may suggest edits; omit to use HackMD’s default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HACKMD_GET_ACCOUNTReturn the HackMD profile for the connected token and the teams visible to it. Use the returned team paths with tools that accept team_path.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HACKMD_GET_NOTEGet a note by ID, including its Markdown content. The personal note route can also retrieve an accessible team note, so no team selector is needed.

Input Parameters

string
required
Unique note ID returned by a note list or create call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HACKMD_LIST_FOLDERSList all folders in the personal workspace, or in one team workspace when team_path is supplied. Use a folder ID as parent_folder_id when creating a note. The team route is documented but was not live-tested.

Input Parameters

string
Team path from HACKMD_GET_ACCOUNT. Omit for personal folders; the team branch was not live-verified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HACKMD_LIST_NOTESList all notes in the personal workspace, or in one team workspace when team_path is supplied. HackMD returns the complete collection without pagination; the team route is documented but was not live-tested.

Input Parameters

string
Team path from HACKMD_GET_ACCOUNT. Omit for the personal workspace; team access depends on the connected account’s membership and was not live-verified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HACKMD_LIST_TRASHList soft-deleted notes in the personal workspace. Team trash is intentionally excluded because it requires team-admin permission and could not be live-tested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HACKMD_MOVE_NOTE_TO_TRASHSoft-delete a note by moving it to trash in the personal workspace or an explicitly selected team workspace. This is not permanent deletion. Personal notes can be restored with HACKMD_RESTORE_NOTES; team deletion is documented but was not live-verified, and no team restore endpoint is mapped.

Input Parameters

string
required
Unique note ID to move to trash.
string
Team path from HACKMD_GET_ACCOUNT. Omit for a personal note; team deletion is documented but was not live-verified and has no mapped restore counterpart.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HACKMD_RESTORE_NOTESRestore one or more personal notes from HackMD trash. Returns a per-note success or failure outcome so a partial HTTP 207 result is never reported as an unconditional success.

Input Parameters

array
required
One or more encoded personal trash note IDs from HACKMD_LIST_TRASH.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not