# NodeBB

> Run your NodeBB community forum: post and reply to topics, find, pin, lock, move and delete them, create users and manage their groups, and start a workflow on a new topic or post.

App · 14 actions. Web page: https://docs.lodol.com/docs/integrations/nodebb

## Actions

### Add user to group

Add a user to a group, such as customers after a purchase. Someone already in it stays in it.

**Inputs**

- User (`user`, text, required): The user's username, email address (once they've confirmed it), ID or profile link.
- Group (`group`, text, required): The group: its name.

**Outputs**

- `group` (text): The group's name
- `group_slug` (text): The group's short name, as in its link
- `member` (true/false): Whether they're in the group now
- `user` (text): The user's username
- `user_id` (number): The user's ID
- `was_member` (true/false): When removing, whether they were in it

**Example output**

```json
{
  "group": "Customers",
  "group_slug": "customers",
  "member": true,
  "user": "sam",
  "user_id": 7,
  "was_member": false
}
```

### Create topic

Start a topic in a category, such as an announcement of a release, an event or a blog post, written in Markdown, with tags.

**Inputs**

- Category (`category`, text, required): The category to post in: its name or ID.
- Title (`title`, text, required): The topic's title.
- Content (`content`, text, required): The first post, in Markdown: **bold**, lists, links and pictures by their address.
- Tags (`tags`, list): Tags to file it under. New ones are made. NodeBB leaves out a tag shorter or longer than the forum allows (3 to 15 letters unless changed).

**Outputs**

- `author` (text): The username of who started it
- `author_id` (number): Their user ID
- `category` (text): The category it's in
- `category_id` (number): The category's ID
- `content` (text): The first post as plain text
- `content_html` (text): The first post as HTML
- `created_at` (text): When it was started (ISO 8601)
- `first_post_id` (number): The ID of its first post
- `id` (number): The topic's ID
- `last_post_at` (text): When the latest post was made (ISO 8601)
- `locked` (true/false): Whether it's locked, so only moderators can reply
- `pinned` (true/false): Whether it's pinned to the top of its category
- `post_count` (number): How many posts it has, the first one included
- `tags` (list): Its tags
- `title` (text): Its title
- `url` (text): A link to the topic
- `view_count` (number): How many times it has been viewed

**Example output**

```json
{
  "author": "jane",
  "author_id": 1,
  "category": "Announcements",
  "category_id": 1,
  "content": "Version 2.4 adds dark mode.",
  "content_html": "<p>Version 2.4 adds <strong>dark mode</strong>.</p>\n",
  "created_at": "2026-11-02T10:00:00Z",
  "first_post_id": 310,
  "id": 42,
  "last_post_at": "2026-11-03T08:30:00Z",
  "locked": false,
  "pinned": false,
  "post_count": 1,
  "tags": [
    "release"
  ],
  "title": "Version 2.4 is out",
  "url": "https://community.example.com/topic/42/version-2-4-is-out",
  "view_count": 120
}
```

### Create user

Create a user, such as for a new customer. NodeBB emails them to confirm their address and set a password. One already there with that email address is answered as it is.

**Inputs**

- Username (`username`, text, required): Their username. One taken by someone else is refused.
- Email (`email`, text): Their email address. NodeBB sends a welcome email to it.
- Email already confirmed (`email_confirmed`, true/false): Mark the email address as confirmed, for an address you already know is theirs, such as from a purchase.

**Outputs**

- `already_existed` (true/false): Whether the user was already there, with that email address
- `banned` (true/false): Whether they're banned
- `display_name` (text): The name the forum shows for them
- `email` (text): Their email address, once confirmed
- `email_confirmed` (true/false): Whether they've confirmed their email address
- `groups` (list): The groups they're in that show on their profile
- `id` (number): The user's ID
- `joined_at` (text): When they joined (ISO 8601)
- `last_online_at` (text): When they were last online (ISO 8601)
- `post_count` (number): How many posts they've made
- `profile_url` (text): A link to their profile
- `reputation` (number): Their reputation
- `topic_count` (number): How many topics they've started
- `username` (text): Their username

**Example output**

```json
{
  "already_existed": false,
  "banned": false,
  "display_name": "sam",
  "email": "sam@example.com",
  "email_confirmed": false,
  "groups": [],
  "id": 7,
  "joined_at": "2026-01-15T09:00:00Z",
  "last_online_at": "2026-11-03T08:30:00Z",
  "post_count": 0,
  "profile_url": "https://community.example.com/user/sam",
  "reputation": 0,
  "topic_count": 0,
  "username": "sam"
}
```

### Delete topic

Delete a topic: into the trash, where moderators can restore it, or for good with its posts.

**Inputs**

- Topic (`topic`, text, required): The topic's ID, such as one from 'Find topics' or a trigger, or its link (…/topic/42/its-title).
- Delete for good (`permanently`, true/false): Delete it and its posts for good, rather than into the trash. This can't be undone.

**Outputs**

- `already_deleted` (true/false): Whether it was already in the trash
- `category` (text): The category it was in
- `category_id` (number): That category's ID
- `id` (number): The topic's ID
- `permanently` (true/false): Whether it was deleted for good, with its posts
- `title` (text): Its title

**Example output**

```json
{
  "already_deleted": false,
  "category": "Announcements",
  "category_id": 1,
  "id": 42,
  "permanently": false,
  "title": "Version 2.4 is out"
}
```

### Find topics

Find topics by category, words or tag: the most recently active first, or with words, the newest matches first.

**Inputs**

- Category (`category`, text): Only topics in this category and those inside it. Leave blank for every category.
- Words (`search`, text): Only topics with these words in their title or posts.
- Tag (`tag`, text): Only topics with this tag.
- How many (`limit`, number): The most to find, up to 50. Defaults to 20. From 1 to 50.

**Outputs**

- `count` (number): How many were found
- `topics` (list): The topics found

**Example output**

```json
{
  "count": 1,
  "topics": [
    {
      "author": "jane",
      "author_id": 1,
      "category": "Announcements",
      "category_id": 1,
      "created_at": "2026-11-02T10:00:00Z",
      "first_post_id": 310,
      "id": 42,
      "last_post_at": "2026-11-03T08:30:00Z",
      "locked": false,
      "pinned": false,
      "post_count": 3,
      "tags": [
        "release"
      ],
      "title": "Version 2.4 is out",
      "url": "https://community.example.com/topic/42/version-2-4-is-out",
      "view_count": 120
    }
  ]
}
```

### Find user

Find a user by their username, email address or ID, with their groups. Says when there's none.

**Inputs**

- User (`user`, text, required): The user's username, email address (once they've confirmed it), ID or profile link.

**Outputs**

- `banned` (true/false): Whether they're banned
- `display_name` (text): The name the forum shows for them
- `email` (text): Their email address, once confirmed
- `email_confirmed` (true/false): Whether they've confirmed their email address
- `found` (true/false): Whether a user was found
- `groups` (list): The groups they're in that show on their profile
- `id` (number): The user's ID
- `joined_at` (text): When they joined (ISO 8601)
- `last_online_at` (text): When they were last online (ISO 8601)
- `post_count` (number): How many posts they've made
- `profile_url` (text): A link to their profile
- `reputation` (number): Their reputation
- `topic_count` (number): How many topics they've started
- `username` (text): Their username

**Example output**

```json
{
  "banned": false,
  "display_name": "sam",
  "email": "sam@example.com",
  "email_confirmed": true,
  "found": true,
  "groups": [
    "Customers"
  ],
  "id": 7,
  "joined_at": "2026-01-15T09:00:00Z",
  "last_online_at": "2026-11-03T08:30:00Z",
  "post_count": 12,
  "profile_url": "https://community.example.com/user/sam",
  "reputation": 5,
  "topic_count": 2,
  "username": "sam"
}
```

### Get topic

Get a topic with its posts, oldest first, as text and HTML, and the whole conversation as one text, such as for an AI summary.

**Inputs**

- Topic (`topic`, text, required): The topic's ID, such as one from 'Find topics' or a trigger, or its link (…/topic/42/its-title).
- How many posts (`post_limit`, number): The most posts to get, from the first, up to 500. Defaults to 50. From 1 to 500.

**Outputs**

- `author` (text): The username of who started it
- `author_id` (number): Their user ID
- `category` (text): The category it's in
- `category_id` (number): The category's ID
- `content` (text): The first post as plain text
- `conversation` (text): Every post as one text, each with who wrote it and when, for an AI step
- `created_at` (text): When it was started (ISO 8601)
- `first_post_id` (number): The ID of its first post
- `id` (number): The topic's ID
- `last_post_at` (text): When the latest post was made (ISO 8601)
- `locked` (true/false): Whether it's locked, so only moderators can reply
- `pinned` (true/false): Whether it's pinned to the top of its category
- `post_count` (number): How many posts it has, the first one included
- `posts` (list): Its posts, oldest first, the first post included
- `tags` (list): Its tags
- `title` (text): Its title
- `url` (text): A link to the topic
- `view_count` (number): How many times it has been viewed

**Example output**

```json
{
  "author": "jane",
  "author_id": 1,
  "category": "Announcements",
  "category_id": 1,
  "content": "Version 2.4 adds dark mode.",
  "conversation": "jane (2026-11-02T10:00:00Z):\nVersion 2.4 adds dark mode.\n\nsam (2026-11-02T11:00:00Z):\nDoes dark mode follow the system setting?",
  "created_at": "2026-11-02T10:00:00Z",
  "first_post_id": 310,
  "id": 42,
  "last_post_at": "2026-11-03T08:30:00Z",
  "locked": false,
  "pinned": false,
  "post_count": 2,
  "posts": [
    {
      "author": "jane",
      "author_id": 1,
      "content": "Version 2.4 adds dark mode.",
      "content_html": "<p>Version 2.4 adds dark mode.</p>\n",
      "created_at": "2026-11-02T10:00:00Z",
      "id": 310,
      "reply_to_post_id": 0,
      "topic_id": 42,
      "url": "https://community.example.com/post/310",
      "votes": 2
    },
    {
      "author": "sam",
      "author_id": 7,
      "content": "Does dark mode follow the system setting?",
      "content_html": "<p>Does <strong>dark mode</strong> follow the system setting?</p>\n",
      "created_at": "2026-11-02T11:00:00Z",
      "id": 311,
      "reply_to_post_id": 0,
      "topic_id": 42,
      "url": "https://community.example.com/post/311",
      "votes": 2
    }
  ],
  "tags": [
    "release"
  ],
  "title": "Version 2.4 is out",
  "url": "https://community.example.com/topic/42/version-2-4-is-out",
  "view_count": 120
}
```

### List categories

List the forum's categories, with what's inside each and how many topics and posts they have.

**Inputs**: None.

**Outputs**

- `categories` (list): The forum's categories
- `count` (number): How many there are

**Example output**

```json
{
  "categories": [
    {
      "description": "News from the team",
      "id": 1,
      "name": "Announcements",
      "parent": "",
      "parent_id": 0,
      "post_count": 40,
      "topic_count": 14,
      "url": "https://community.example.com/category/1/announcements"
    }
  ],
  "count": 1
}
```

### List groups

List the forum's groups people can be added to, with how many members each has. NodeBB's own groups, such as administrators, are left out.

**Inputs**: None.

**Outputs**

- `count` (number): How many there are
- `groups` (list): The groups people can be added to

**Example output**

```json
{
  "count": 1,
  "groups": [
    {
      "description": "People who bought a plan",
      "hidden": false,
      "member_count": 120,
      "name": "Customers",
      "private": false,
      "slug": "customers",
      "url": "https://community.example.com/groups/customers"
    }
  ]
}
```

### Lock or unlock topic

Lock a topic so only moderators can reply, such as a solved question, or unlock it. One already as asked is left as it is.

**Inputs**

- Topic (`topic`, text, required): The topic's ID, such as one from 'Find topics' or a trigger, or its link (…/topic/42/its-title).
- Lock or unlock (`locked`, text): Whether to lock it or unlock it. One of: `lock`, `unlock`. Default: `lock`.

**Outputs**

- `author` (text): The username of who started it
- `author_id` (number): Their user ID
- `category` (text): The category it's in
- `category_id` (number): The category's ID
- `created_at` (text): When it was started (ISO 8601)
- `first_post_id` (number): The ID of its first post
- `id` (number): The topic's ID
- `last_post_at` (text): When the latest post was made (ISO 8601)
- `locked` (true/false): Whether it's locked, so only moderators can reply
- `pinned` (true/false): Whether it's pinned to the top of its category
- `post_count` (number): How many posts it has, the first one included
- `tags` (list): Its tags
- `title` (text): Its title
- `url` (text): A link to the topic
- `view_count` (number): How many times it has been viewed

**Example output**

```json
{
  "author": "jane",
  "author_id": 1,
  "category": "Announcements",
  "category_id": 1,
  "created_at": "2026-11-02T10:00:00Z",
  "first_post_id": 310,
  "id": 42,
  "last_post_at": "2026-11-03T08:30:00Z",
  "locked": true,
  "pinned": false,
  "post_count": 3,
  "tags": [
    "release"
  ],
  "title": "Version 2.4 is out",
  "url": "https://community.example.com/topic/42/version-2-4-is-out",
  "view_count": 120
}
```

### Move topic

Move a topic to another category, with its posts.

**Inputs**

- Topic (`topic`, text, required): The topic's ID, such as one from 'Find topics' or a trigger, or its link (…/topic/42/its-title).
- Category (`category`, text, required): The category to move it to: its name or ID.

**Outputs**

- `author` (text): The username of who started it
- `author_id` (number): Their user ID
- `category` (text): The category it's in
- `category_id` (number): The category's ID
- `created_at` (text): When it was started (ISO 8601)
- `first_post_id` (number): The ID of its first post
- `id` (number): The topic's ID
- `last_post_at` (text): When the latest post was made (ISO 8601)
- `locked` (true/false): Whether it's locked, so only moderators can reply
- `moved_from` (text): The category it was in
- `moved_from_id` (number): That category's ID
- `pinned` (true/false): Whether it's pinned to the top of its category
- `post_count` (number): How many posts it has, the first one included
- `tags` (list): Its tags
- `title` (text): Its title
- `url` (text): A link to the topic
- `view_count` (number): How many times it has been viewed

**Example output**

```json
{
  "author": "jane",
  "author_id": 1,
  "category": "Support",
  "category_id": 6,
  "created_at": "2026-11-02T10:00:00Z",
  "first_post_id": 310,
  "id": 42,
  "last_post_at": "2026-11-03T08:30:00Z",
  "locked": false,
  "moved_from": "Announcements",
  "moved_from_id": 1,
  "pinned": false,
  "post_count": 3,
  "tags": [
    "release"
  ],
  "title": "Version 2.4 is out",
  "url": "https://community.example.com/topic/42/version-2-4-is-out",
  "view_count": 120
}
```

### Pin or unpin topic

Pin a topic to the top of its category, until a time if you like, or unpin it. One already as asked is left as it is.

**Inputs**

- Topic (`topic`, text, required): The topic's ID, such as one from 'Find topics' or a trigger, or its link (…/topic/42/its-title).
- Pin or unpin (`pinned`, text): Whether to pin it or unpin it. One of: `pin`, `unpin`. Default: `pin`.
- Unpin at (`unpin_at`, date and time): When pinning, a time for NodeBB to unpin it by itself. Leave blank to keep it pinned.

**Outputs**

- `author` (text): The username of who started it
- `author_id` (number): Their user ID
- `category` (text): The category it's in
- `category_id` (number): The category's ID
- `created_at` (text): When it was started (ISO 8601)
- `first_post_id` (number): The ID of its first post
- `id` (number): The topic's ID
- `last_post_at` (text): When the latest post was made (ISO 8601)
- `locked` (true/false): Whether it's locked, so only moderators can reply
- `pinned` (true/false): Whether it's pinned to the top of its category
- `post_count` (number): How many posts it has, the first one included
- `tags` (list): Its tags
- `title` (text): Its title
- `unpins_at` (text): When NodeBB unpins it by itself (ISO 8601), if set
- `url` (text): A link to the topic
- `view_count` (number): How many times it has been viewed

**Example output**

```json
{
  "author": "jane",
  "author_id": 1,
  "category": "Announcements",
  "category_id": 1,
  "created_at": "2026-11-02T10:00:00Z",
  "first_post_id": 310,
  "id": 42,
  "last_post_at": "2026-11-03T08:30:00Z",
  "locked": false,
  "pinned": true,
  "post_count": 3,
  "tags": [
    "release"
  ],
  "title": "Version 2.4 is out",
  "unpins_at": "",
  "url": "https://community.example.com/topic/42/version-2-4-is-out",
  "view_count": 120
}
```

### Remove user from group

Take a user out of a group, such as when a subscription ends. Says whether they were in it.

**Inputs**

- User (`user`, text, required): The user's username, email address (once they've confirmed it), ID or profile link.
- Group (`group`, text, required): The group: its name.

**Outputs**

- `group` (text): The group's name
- `group_slug` (text): The group's short name, as in its link
- `member` (true/false): Whether they're in the group now
- `user` (text): The user's username
- `user_id` (number): The user's ID
- `was_member` (true/false): When removing, whether they were in it

**Example output**

```json
{
  "group": "Customers",
  "group_slug": "customers",
  "member": false,
  "user": "sam",
  "user_id": 7,
  "was_member": true
}
```

### Reply to topic

Post a reply in a topic, such as an answer to a support question, written in Markdown.

**Inputs**

- Topic (`topic`, text, required): The topic's ID, such as one from 'Find topics' or a trigger, or its link (…/topic/42/its-title).
- Content (`content`, text, required): The reply, in Markdown.
- In reply to post (`reply_to`, text): To answer one post in the topic, its ID or link (…/post/42). Leave blank to reply to the topic.

**Outputs**

- `author` (text): The username of who wrote it
- `author_id` (number): Their user ID
- `content` (text): What it says, as plain text
- `content_html` (text): What it says, as HTML
- `created_at` (text): When it was posted (ISO 8601)
- `id` (number): The post's ID
- `reply_to_post_id` (number): The post it replies to, or 0
- `topic_id` (number): The topic it's in
- `topic_title` (text): The topic's title
- `topic_url` (text): A link to the topic
- `url` (text): A link to the post
- `votes` (number): Upvotes minus downvotes

**Example output**

```json
{
  "author": "jane",
  "author_id": 1,
  "content": "Yes, it does.",
  "content_html": "<p>Yes, it does.</p>\n",
  "created_at": "2026-11-02T11:00:00Z",
  "id": 311,
  "reply_to_post_id": 0,
  "topic_id": 42,
  "topic_title": "Version 2.4 is out",
  "topic_url": "https://community.example.com/topic/42/version-2-4-is-out",
  "url": "https://community.example.com/post/311",
  "votes": 2
}
```
