Discourse Integration with Orkes Conductor

Available since

• v5.3.0 and later

Integrating Discourse with Orkes Conductor lets you build workflows that interact with your Discourse using the following operations:

• Create Post
• Get Post
• List Posts
• Update Post
• Create Category
• List Categories
• Update Category
• Create User
• Get User
• List Users
• Create Group
• Get Group
• List Groups
• Update Group
• Add User to Group
• Remove User from Group

This guide explains how to set up and use the integration. Here’s an overview:

1. Get the required credentials from Discourse.
2. Configure a new Discourse integration in Orkes Conductor.
3. Use Discourse integration in workflows.

Step 1: Get the Discourse credentials

To integrate Discourse with Orkes Conductor, get the API key and username from Discourse.

To get the API key:

1. Go to Admin > Advanced > API Keys from the Discourse admin account.
2. Select New API Key.
3. Enter a description, set the User Level to All Users, and set the Scope to Global.
4. Select Save.
5. Copy the generated API key and store it securely, as it is shown only once.

Step 2: Add an integration for Discourse

After obtaining the credentials, add a Discourse integration to your Conductor cluster.

To create an integration:

1. Go to Integrations > Connected Apps from the left navigation menu on your Conductor cluster.
2. Select + New integration.
3. In the Project Management section, choose Discourse.
4. Select + Add and enter the following parameters:

Parameter	Description	Required/Optional
Integration name	A name for the integration.	Required.
API Key	The Admin API key retrieved from Discourse in Step 1.	Required.
API Username	The username associated with the API key.	Required.
Base URL	The Discourse instance base URL.	Required.
Description	A description of the integration.	Required.

5. (Optional) Toggle the Active button off if you don’t want to activate the integration instantly.
6. Select Save.

Step 3: Use Discourse integration in workflows

Once the integration is ready, this can be used directly within the workflows.

To use Discourse integration in a workflow:

1. Go to Definitions > Workflow from the left navigation menu on your Conductor cluster.
2. Select + Define workflow.
3. In your workflow, select the (+) icon and select Connected Apps.

4. In Add Task panel on the right, search for Discourse, and select the integration created in Step 2.

The following operations are available for use with this integration.

Operation	Description
Create Post	Create a new topic or reply to an existing topic.
Get Post	Retrieve a single post by its ID.
List Posts	List latest posts across all topics.
Update Post	Update the content of an existing post.
Create Category	Create a new category in the Discourse forum.
List Categories	Retrieve all categories from the forum.
Update Category	Update an existing category's properties.
Create User	Create a new user account.
Get User	Get a user profile by username.
List Users	List users with optional filtering (admin only).
Create Group	Create a new user group.
Get Group	Get details of a specific group by name.
List Groups	List all groups in the forum.
Update Group	Update an existing group's properties
Add User to Group	Add one or more users to a group.
Remove User from Group	Remove one or more users from a group.

5. Select the required operation, configure the parameters, and select Save > Confirm.
6. Select Execute to run the workflow.

For the complete operations parameters and output reference, see Discourse Operations Reference.