NodeBB
App · 14 actions
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.
Actions
| Action | What it does |
|---|---|
| Add user to group | Add a user to a group, such as customers after a purchase. |
| 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. |
| Create user | Create a user, such as for a new customer. |
| Delete topic | Delete a topic: into the trash, where moderators can restore it, or for good with its posts. |
| Find topics | Find topics by category, words or tag: the most recently active first, or with words, the newest matches first. |
| Find user | Find a user by their username, email address or ID, with their groups. |
| 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. |
| List categories | List the forum's categories, with what's inside each and how many topics and posts they have. |
| List groups | List the forum's groups people can be added to, with how many members each has. |
| Lock or unlock topic | Lock a topic so only moderators can reply, such as a solved question, or unlock it. |
| Move topic | Move a topic to another category, with its posts. |
| Pin or unpin topic | Pin a topic to the top of its category, until a time if you like, or unpin it. |
| Remove user from group | Take a user out of a group, such as when a subscription ends. |
| Reply to topic | Post a reply in a topic, such as an answer to a support question, written in Markdown. |
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
usertextRequired - The user's username, email address (once they've confirmed it), ID or profile link.
- Group
grouptextRequired - The group: its name.
Outputs
grouptext- The group's name
group_slugtext- The group's short name, as in its link
membertrue/false- Whether they're in the group now
usertext- The user's username
user_idnumber- The user's ID
was_membertrue/false- When removing, whether they were in it
Example output
{
"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
categorytextRequired - The category to post in: its name or ID.
- Title
titletextRequired - The topic's title.
- Content
contenttextRequired - The first post, in Markdown: **bold**, lists, links and pictures by their address.
- Tags
tagslist - 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
authortext- The username of who started it
author_idnumber- Their user ID
categorytext- The category it's in
category_idnumber- The category's ID
contenttext- The first post as plain text
content_htmltext- The first post as HTML
created_attext- When it was started (ISO 8601)
first_post_idnumber- The ID of its first post
idnumber- The topic's ID
last_post_attext- When the latest post was made (ISO 8601)
lockedtrue/false- Whether it's locked, so only moderators can reply
pinnedtrue/false- Whether it's pinned to the top of its category
post_countnumber- How many posts it has, the first one included
tagslist- Its tags
titletext- Its title
urltext- A link to the topic
view_countnumber- How many times it has been viewed
Example output
{
"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
usernametextRequired - Their username. One taken by someone else is refused.
- Email
emailtext - Their email address. NodeBB sends a welcome email to it.
- Email already confirmed
email_confirmedtrue/false - Mark the email address as confirmed, for an address you already know is theirs, such as from a purchase.
Outputs
already_existedtrue/false- Whether the user was already there, with that email address
bannedtrue/false- Whether they're banned
display_nametext- The name the forum shows for them
emailtext- Their email address, once confirmed
email_confirmedtrue/false- Whether they've confirmed their email address
groupslist- The groups they're in that show on their profile
idnumber- The user's ID
joined_attext- When they joined (ISO 8601)
last_online_attext- When they were last online (ISO 8601)
post_countnumber- How many posts they've made
profile_urltext- A link to their profile
reputationnumber- Their reputation
topic_countnumber- How many topics they've started
usernametext- Their username
Example output
{
"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
topictextRequired - The topic's ID, such as one from 'Find topics' or a trigger, or its link (…/topic/42/its-title).
- Delete for good
permanentlytrue/false - Delete it and its posts for good, rather than into the trash. This can't be undone.
Outputs
already_deletedtrue/false- Whether it was already in the trash
categorytext- The category it was in
category_idnumber- That category's ID
idnumber- The topic's ID
permanentlytrue/false- Whether it was deleted for good, with its posts
titletext- Its title
Example output
{
"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
categorytext - Only topics in this category and those inside it. Leave blank for every category.
- Words
searchtext - Only topics with these words in their title or posts.
- Tag
tagtext - Only topics with this tag.
- How many
limitnumber - The most to find, up to 50. Defaults to 20.From 1 to 50.
Outputs
countnumber- How many were found
topicslist- The topics found
Example output
{
"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
usertextRequired - The user's username, email address (once they've confirmed it), ID or profile link.
Outputs
bannedtrue/false- Whether they're banned
display_nametext- The name the forum shows for them
emailtext- Their email address, once confirmed
email_confirmedtrue/false- Whether they've confirmed their email address
foundtrue/false- Whether a user was found
groupslist- The groups they're in that show on their profile
idnumber- The user's ID
joined_attext- When they joined (ISO 8601)
last_online_attext- When they were last online (ISO 8601)
post_countnumber- How many posts they've made
profile_urltext- A link to their profile
reputationnumber- Their reputation
topic_countnumber- How many topics they've started
usernametext- Their username
Example output
{
"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
topictextRequired - The topic's ID, such as one from 'Find topics' or a trigger, or its link (…/topic/42/its-title).
- How many posts
post_limitnumber - The most posts to get, from the first, up to 500. Defaults to 50.From 1 to 500.
Outputs
authortext- The username of who started it
author_idnumber- Their user ID
categorytext- The category it's in
category_idnumber- The category's ID
contenttext- The first post as plain text
conversationtext- Every post as one text, each with who wrote it and when, for an AI step
created_attext- When it was started (ISO 8601)
first_post_idnumber- The ID of its first post
idnumber- The topic's ID
last_post_attext- When the latest post was made (ISO 8601)
lockedtrue/false- Whether it's locked, so only moderators can reply
pinnedtrue/false- Whether it's pinned to the top of its category
post_countnumber- How many posts it has, the first one included
postslist- Its posts, oldest first, the first post included
tagslist- Its tags
titletext- Its title
urltext- A link to the topic
view_countnumber- How many times it has been viewed
Example output
{
"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
categorieslist- The forum's categories
countnumber- How many there are
Example output
{
"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
countnumber- How many there are
groupslist- The groups people can be added to
Example output
{
"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
topictextRequired - The topic's ID, such as one from 'Find topics' or a trigger, or its link (…/topic/42/its-title).
- Lock or unlock
lockedtext - Whether to lock it or unlock it.One of:
lock,unlock. Default:lock.
Outputs
authortext- The username of who started it
author_idnumber- Their user ID
categorytext- The category it's in
category_idnumber- The category's ID
created_attext- When it was started (ISO 8601)
first_post_idnumber- The ID of its first post
idnumber- The topic's ID
last_post_attext- When the latest post was made (ISO 8601)
lockedtrue/false- Whether it's locked, so only moderators can reply
pinnedtrue/false- Whether it's pinned to the top of its category
post_countnumber- How many posts it has, the first one included
tagslist- Its tags
titletext- Its title
urltext- A link to the topic
view_countnumber- How many times it has been viewed
Example output
{
"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
topictextRequired - The topic's ID, such as one from 'Find topics' or a trigger, or its link (…/topic/42/its-title).
- Category
categorytextRequired - The category to move it to: its name or ID.
Outputs
authortext- The username of who started it
author_idnumber- Their user ID
categorytext- The category it's in
category_idnumber- The category's ID
created_attext- When it was started (ISO 8601)
first_post_idnumber- The ID of its first post
idnumber- The topic's ID
last_post_attext- When the latest post was made (ISO 8601)
lockedtrue/false- Whether it's locked, so only moderators can reply
moved_fromtext- The category it was in
moved_from_idnumber- That category's ID
pinnedtrue/false- Whether it's pinned to the top of its category
post_countnumber- How many posts it has, the first one included
tagslist- Its tags
titletext- Its title
urltext- A link to the topic
view_countnumber- How many times it has been viewed
Example output
{
"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
topictextRequired - The topic's ID, such as one from 'Find topics' or a trigger, or its link (…/topic/42/its-title).
- Pin or unpin
pinnedtext - Whether to pin it or unpin it.One of:
pin,unpin. Default:pin. - Unpin at
unpin_atdate and time - When pinning, a time for NodeBB to unpin it by itself. Leave blank to keep it pinned.
Outputs
authortext- The username of who started it
author_idnumber- Their user ID
categorytext- The category it's in
category_idnumber- The category's ID
created_attext- When it was started (ISO 8601)
first_post_idnumber- The ID of its first post
idnumber- The topic's ID
last_post_attext- When the latest post was made (ISO 8601)
lockedtrue/false- Whether it's locked, so only moderators can reply
pinnedtrue/false- Whether it's pinned to the top of its category
post_countnumber- How many posts it has, the first one included
tagslist- Its tags
titletext- Its title
unpins_attext- When NodeBB unpins it by itself (ISO 8601), if set
urltext- A link to the topic
view_countnumber- How many times it has been viewed
Example output
{
"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
usertextRequired - The user's username, email address (once they've confirmed it), ID or profile link.
- Group
grouptextRequired - The group: its name.
Outputs
grouptext- The group's name
group_slugtext- The group's short name, as in its link
membertrue/false- Whether they're in the group now
usertext- The user's username
user_idnumber- The user's ID
was_membertrue/false- When removing, whether they were in it
Example output
{
"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
topictextRequired - The topic's ID, such as one from 'Find topics' or a trigger, or its link (…/topic/42/its-title).
- Content
contenttextRequired - The reply, in Markdown.
- In reply to post
reply_totext - To answer one post in the topic, its ID or link (…/post/42). Leave blank to reply to the topic.
Outputs
authortext- The username of who wrote it
author_idnumber- Their user ID
contenttext- What it says, as plain text
content_htmltext- What it says, as HTML
created_attext- When it was posted (ISO 8601)
idnumber- The post's ID
reply_to_post_idnumber- The post it replies to, or 0
topic_idnumber- The topic it's in
topic_titletext- The topic's title
topic_urltext- A link to the topic
urltext- A link to the post
votesnumber- Upvotes minus downvotes
Example output
{
"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
}