> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Discourse

> How to set up the Discourse connector, plus the actions and events that are available.

![Discourse](https://stackone-logos.com/api/discourse/filled/svg)

v1.2.0[See changelog](https://docs.stackone.com/connectors/discourse/changelog.md)

[67 actions](#actions) · [50 events](#events) · 1 auth method

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/discourse/guides/connector-profile/api-key.md)
>
> Generate an API key from your Discourse admin panel to authenticate requests. You will also need a username (typically s...

Optionally, configure receiving Events for Discourse into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/discourse/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/discourse/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

67 actions

ActionDescription

List Badges`discourse_list_badges`

List all badges available in the Discourse instance (admin only).

Create Badge`discourse_create_badge`

Create a new custom badge (admin only).

Update Badge`discourse_update_badge`

Update the settings of an existing badge (admin only).

Delete Badge`discourse_delete_badge`

Permanently delete a badge (admin only).

List User Badges`discourse_list_user_badges`

Get all badges earned by a specific user.

List Categories`discourse_list_categories`

List all topic categories in the Discourse instance.

Get Category`discourse_get_category`

Retrieve a single category by its ID.

List Category Topics`discourse_list_category_topics`

Get all topics in a specific category.

Create Category`discourse_create_category`

Create a new topic category (admin only).

Update Category`discourse_update_category`

Update the settings or metadata of an existing category (admin only).

List Groups`discourse_list_groups`

List all groups in the Discourse instance.

Get Group`discourse_get_group`

Retrieve details about a specific group by its name.

Get Group By ID`discourse_get_group_by_id`

Retrieve details about a specific group by its numeric ID.

List Group Members`discourse_list_group_members`

Get all members of a specific group.

Create Group`discourse_create_group`

Create a new user group in Discourse (admin only).

Update Group`discourse_update_group`

Update the settings or metadata of an existing group.

Add Group Members`discourse_add_group_members`

Add one or more users to a group.

Remove Group Members`discourse_remove_group_members`

Remove one or more users from a group.

Delete Group`discourse_delete_group`

Permanently delete a group (admin only).

List Notifications`discourse_list_notifications`

List notifications for the currently authenticated user.

Mark Notifications Read`discourse_mark_notifications_read`

Mark one or all notifications as read for the authenticated user.

List Latest Posts`discourse_list_posts`

Get the latest posts from across all topics in the forum.

Create Post`discourse_create_post`

Reply to an existing topic (use create\_topic to start a new topic).

Get Post`discourse_get_post`

Retrieve a single post by its ID.

Update Post`discourse_update_post`

Edit the Markdown content of an existing post.

Delete Post`discourse_delete_post`

Delete a post from a topic.

List Post Replies`discourse_list_post_replies`

Get all direct replies to a specific post.

Lock Post`discourse_lock_post`

Lock or unlock a post to prevent or allow editing.

Create Post Action`discourse_create_post_action`

Like a post or flag it for moderator attention.

List Private Messages`discourse_list_private_messages`

Get private messages received by a specific user.

List Sent Private Messages`discourse_list_sent_private_messages`

Get private messages sent by a specific user.

Create Private Message`discourse_create_private_message`

Send a private message to one or more users or groups.

Search`discourse_search`

Search for topics, posts, users, and categories across the Discourse forum.

Get Site Info`discourse_get_site`

Retrieve full site configuration and metadata for the Discourse instance.

Get Site Basic Info`discourse_get_site_basic_info`

Retrieve basic public information about the Discourse instance.

Get About`discourse_get_about`

Retrieve public site statistics and staff information.

List Tags`discourse_list_tags`

List all tags used in the Discourse forum.

Get Tag`discourse_get_tag`

Retrieve details and topics for a specific tag.

List Tag Groups`discourse_list_tag_groups`

List all tag groups defined in the Discourse instance.

Get Tag Group`discourse_get_tag_group`

Retrieve a specific tag group by its ID.

Create Tag Group`discourse_create_tag_group`

Create a new tag group to organize related tags (admin only).

Update Tag Group`discourse_update_tag_group`

Update the name or tags of an existing tag group (admin only).

List Latest Topics`discourse_list_latest_topics`

Get the latest topics from the Discourse forum, sorted by recent activity.

List Top Topics`discourse_list_top_topics`

Get the top-ranked topics filtered by time period from the Discourse forum.

Get Topic`discourse_get_topic`

Retrieve a single topic and its posts by topic ID.

Update Topic`discourse_update_topic`

Update the title, category, or tags of an existing topic.

Delete Topic`discourse_delete_topic`

Delete a topic and all its posts (admin or moderator only).

Update Topic Status`discourse_update_topic_status`

Enable or disable a status flag on a topic (close, pin, archive, hide, etc.).

Create Topic Timer`discourse_create_topic_timer`

Schedule an automatic action on a topic at a future date and time.

Get Topic Posts`discourse_get_topic_posts`

Retrieve specific posts from a topic by their post IDs.

Create Topic`discourse_create_topic`

Create a new topic in the Discourse forum.

List Users`discourse_list_users`

List all users in the Discourse instance (admin only).

List Users By Flag`discourse_list_users_by_flag`

List users filtered by account status flag (admin only).

Get User`discourse_get_user`

Retrieve a user's public profile by their username.

Get User By ID`discourse_get_user_by_id`

Retrieve a user's full details by their numeric ID (admin only).

Create User`discourse_create_user`

Create a new user account in the Discourse instance.

Update User`discourse_update_user`

Update a user's profile information.

Activate User`discourse_activate_user`

Activate a pending user account (admin only).

Deactivate User`discourse_deactivate_user`

Deactivate a user account to prevent them from logging in (admin only).

Suspend User`discourse_suspend_user`

Suspend a user account until a specified date (admin only).

Delete User`discourse_delete_user`

Permanently delete a user account (admin only).

List User Actions`discourse_list_user_actions`

Get a list of actions performed by a specific user.

Get User Emails`discourse_get_user_emails`

Retrieve the email addresses associated with a user account (admin only).

Log Out User`discourse_log_out_user`

Force-log out a user's current session (admin only).

Silence User`discourse_silence_user`

Silence a user to prevent them from posting without fully suspending their account (admin only).

Anonymize User`discourse_anonymize_user`

Permanently anonymize a user by replacing all identifying information with random values (admin only).

Get User By External ID`discourse_get_user_by_external_id`

Retrieve a Discourse user by their external system ID (SSO/Discourse Connect lookup).

## Events

Tags

Select all
|
Clear

Assignments

Badges

Calendar Events

Categories

Chat

Groups

Health Checks

Notifications

Posts

Review Queue

Solutions

Tags

Topic Voting

Topics

Users

No tags found

50 events

EventDescriptionTags

Ping`discourse_webhook_ping`

Responds with 200 OK to Discourse ping deliveries and any request without an X-Discourse-Event header.

Health Checks

Topic Created`discourse_webhook_topic_created`

Fired when a topic is created in Discourse, including private message topics.

Topics

Topic Edited`discourse_webhook_topic_edited`

Fired when a topic is edited or its status changes (closed, archived, visible, pinned, pinned globally, or auto-closed).

Topics

Topic Deleted`discourse_webhook_topic_destroyed`

Fired when a topic is deleted in Discourse.

Topics

Topic Recovered`discourse_webhook_topic_recovered`

Fired when a deleted topic is recovered in Discourse.

Topics

Post Created`discourse_webhook_post_created`

Fired when a post or reply is created in Discourse, including the first post of a new topic and private message posts.

Posts

Post Edited`discourse_webhook_post_edited`

Fired when a post is edited in Discourse.

Posts

Post Deleted`discourse_webhook_post_destroyed`

Fired when a post is deleted in Discourse.

Posts

Post Recovered`discourse_webhook_post_recovered`

Fired when a deleted post is recovered in Discourse.

Posts

User Logged In`discourse_webhook_user_logged_in`

Fired when a user logs in to Discourse.

Users

User Logged Out`discourse_webhook_user_logged_out`

Fired when a user logs out of Discourse.

Users

User Confirmed Email`discourse_webhook_user_confirmed_email`

Fired when a user confirms their email address in Discourse.

Users

User Created`discourse_webhook_user_created`

Fired when a user account is created in Discourse.

Users

User Approved`discourse_webhook_user_approved`

Fired when a staff member approves a pending user in Discourse.

Users

User Updated`discourse_webhook_user_updated`

Fired when a user profile is updated in Discourse.

Users

User Deleted`discourse_webhook_user_destroyed`

Fired when a user is deleted from Discourse.

Users

User Suspended`discourse_webhook_user_suspended`

Fired when a user is suspended in Discourse.

Users

User Unsuspended`discourse_webhook_user_unsuspended`

Fired when a user suspension is lifted in Discourse.

Users

User Anonymized`discourse_webhook_user_anonymized`

Fired when a user is anonymized in Discourse.

Users

Group Created`discourse_webhook_group_created`

Fired when a group is created in Discourse.

Groups

Group Updated`discourse_webhook_group_updated`

Fired when a group is updated in Discourse.

Groups

Group Deleted`discourse_webhook_group_destroyed`

Fired when a group is deleted from Discourse.

Groups

Category Created`discourse_webhook_category_created`

Fired when a category is created in Discourse.

Categories

Category Updated`discourse_webhook_category_updated`

Fired when a category is updated in Discourse.

Categories

Category Deleted`discourse_webhook_category_destroyed`

Fired when a category is deleted from Discourse.

Categories

Tag Created`discourse_webhook_tag_created`

Fired when a tag is created in Discourse.

Tags

Tag Updated`discourse_webhook_tag_updated`

Fired when a tag is renamed or updated in Discourse.

Tags

Tag Deleted`discourse_webhook_tag_destroyed`

Fired when a tag is deleted from Discourse.

Tags

Reviewable Created`discourse_webhook_reviewable_created`

Fired when an item enters the Discourse review queue, such as a flagged post, a queued post, or a user awaiting approval...

Review Queue

Reviewable Updated`discourse_webhook_reviewable_updated`

Fired when a review queue item gets a new score or changes status (approved, rejected, ignored, or deleted).

Review Queue

Notification Created`discourse_webhook_notification_created`

Fired when Discourse creates a notification for any user on the forum.

Notifications

Solution Accepted`discourse_webhook_accepted_solution`

Fired when a post is marked as the accepted solution of a topic in Discourse.

Solutions

Solution Unaccepted`discourse_webhook_unaccepted_solution`

Fired when an accepted solution is removed from a topic in Discourse.

Solutions

Topic Assigned`discourse_webhook_assigned`

Fired when a topic or post is assigned to a user or group in Discourse.

Assignments

Topic Unassigned`discourse_webhook_unassigned`

Fired when an assignment is removed from a topic or post in Discourse.

Assignments

User Badge Granted`discourse_webhook_user_badge_granted`

Fired when a badge is granted to a user in Discourse.

Badges

User Badge Revoked`discourse_webhook_user_badge_revoked`

Fired when a badge is revoked from a user in Discourse.

Badges

User Added to Group`discourse_webhook_user_added_to_group`

Fired when a user is added to a group in Discourse.

Groups

User Removed from Group`discourse_webhook_user_removed_from_group`

Fired when a user is removed from a group in Discourse.

Groups

Post Liked`discourse_webhook_post_liked`

Fired when a user likes a post in Discourse.

Posts

User Promoted`discourse_webhook_user_promoted`

Fired when a user is promoted to a higher trust level in Discourse.

Users

Topic Upvoted`discourse_webhook_topic_upvote`

Fired when a user votes for a topic in Discourse.

Topic Voting

Topic Vote Removed`discourse_webhook_topic_unvote`

Fired when a user removes their vote from a topic in Discourse.

Topic Voting

Chat Message Created`discourse_webhook_chat_message_created`

Fired when a chat message is sent in a Discourse chat channel or direct message.

Chat

Chat Message Edited`discourse_webhook_chat_message_edited`

Fired when a chat message is edited in Discourse.

Chat

Chat Message Deleted`discourse_webhook_chat_message_trashed`

Fired when a chat message is deleted in Discourse.

Chat

Chat Message Restored`discourse_webhook_chat_message_restored`

Fired when a deleted chat message is restored in Discourse.

Chat

Calendar Event Created`discourse_webhook_calendar_event_created`

Fired when a calendar event is created on a post in Discourse.

Calendar Events

Calendar Event Updated`discourse_webhook_calendar_event_updated`

Fired when a calendar event is updated in Discourse.

Calendar Events

Calendar Event Deleted`discourse_webhook_calendar_event_destroyed`

Fired when a calendar event is deleted in Discourse.

Calendar Events


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.