> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/hackmd.md).

# HackMD

Create, read, update, list, and delete collaborative Markdown notes.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| HackMD    | Access Token   |

#### HackMD

Connect to HackMD to create, read, update, list, and delete notes.

**Set up in HackMD**

1. Prepare the HackMD account or service that the workflow will access. Grant access to the required resources and operations.
2. **Access Token:** Create an API token in HackMD Settings > API.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **HackMD**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                          |
| ------------- | -------- | ------------------------------------------------------------------------------------------------------ |
| Access Token  | Yes      | Create an API token in HackMD Settings > API. [Provider instructions](https://hackmd.io/settings#api). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **HackMD** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create Note

Create a private HackMD note.

**Inputs**

| Field     | Type     | Required | Description                |
| --------- | -------- | -------- | -------------------------- |
| Title     | string   | Yes      | Title of the new note.     |
| Content   | textarea | Yes      | Note body in Markdown.     |
| Permalink | string   | No       | Optional custom permalink. |

**Outputs**

| Field | Type   | Description              |
| ----- | ------ | ------------------------ |
| Note  | object | The created HackMD note. |

#### Update Note

Update a HackMD note's title or Markdown content.

**Inputs**

| Field   | Type     | Required | Description                         |
| ------- | -------- | -------- | ----------------------------------- |
| Note ID | string   | Yes      | ID of the note to update.           |
| Title   | string   | No       | Optional replacement title.         |
| Content | textarea | No       | Optional replacement Markdown body. |

**Outputs**

| Field | Type   | Description              |
| ----- | ------ | ------------------------ |
| Note  | object | The updated HackMD note. |

#### List Notes

List notes owned by the connected HackMD account.

**Inputs**

| Field           | Type    | Required | Description                                                               |
| --------------- | ------- | -------- | ------------------------------------------------------------------------- |
| Maximum Results | integer | No       | Maximum number of notes to return. Minimum: 1. Maximum: 100. Default: 50. |

**Outputs**

| Field | Type          | Description                                  |
| ----- | ------------- | -------------------------------------------- |
| Notes | object\_array | HackMD notes owned by the connected account. |

#### Delete Note

Permanently delete a HackMD note.

**Inputs**

| Field          | Type    | Required | Description                                 |
| -------------- | ------- | -------- | ------------------------------------------- |
| Note ID        | string  | Yes      | ID of the note to permanently delete.       |
| Confirm Delete | boolean | Yes      | Confirm permanent deletion. Default: false. |

**Outputs**

| Field   | Type    | Description                           |
| ------- | ------- | ------------------------------------- |
| Deleted | boolean | Whether HackMD accepted the deletion. |
| Note ID | string  | ID of the deleted note.               |

#### Get Note

Get a HackMD note by ID.

**Inputs**

| Field   | Type   | Required | Description                 |
| ------- | ------ | -------- | --------------------------- |
| Note ID | string | Yes      | ID of the note to retrieve. |

**Outputs**

| Field | Type   | Description                |
| ----- | ------ | -------------------------- |
| Note  | object | The requested HackMD note. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/hackmd.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
