;}%20.st6{fill:url(%23SVGID_00000021089067129159788970000008246765442136188072_);}%20.st7{fill:url(%23SVGID_00000117639240116366130650000015074833605515028638_);}%20.st8{opacity:0.4;fill:url(%23SVGID_00000101781798616409025840000016567063639337360777_);}%20.st9{opacity:0.4;fill:url(%23SVGID_00000052086836598721292040000002033117744178971046_);}%20.st10{opacity:0.4;fill:url(%23SVGID_00000159460939004760751800000002448009281983951536_);}%20.st11{opacity:0.4;fill:url(%23SVGID_00000013177830667419993080000017721442101626521532_);}%20.st12{opacity:0.4;fill:url(%23SVGID_00000152235521444854938490000006526001119318383285_);}%20.st13{opacity:0.4;fill:url(%23SVGID_00000119823135212293698520000012774889010992664993_);}%20%3c/style%3e%3cg%3e%3cpolygon%20class='st2'%20points='134.78,14.22%20114.31,48.21%20101.33,69.75%20158.22,69.75%20177.97,36.95%20191.67,14.22%20'/%3e%3cpolygon%20class='st3'%20points='227.55,69.75%20186.61,69.75%20101.33,69.75%20129.78,119.02%20158.16,119.02%20228.61,119.02%20256,119.02%20'/%3e%3cpolygon%20class='st3'%20points='136.93,132.47%20116.46,167.93%2073.82,241.78%20130.71,241.78%20144.9,217.2%20180.13,156.18%20193.82,132.46%20'/%3e%3cpolygon%20class='st3'%20points='121.7,131.95%20101.23,96.49%2058.59,22.63%2030.15,71.91%2044.34,96.49%2079.57,157.5%2093.26,181.22%20'/%3e%3cpolygon%20class='st2'%20points='64.81,131.95%2025.15,131.21%200,130.74%2028.44,180.01%2066.73,180.72%2093.26,181.21%20'/%3e%3cpolygon%20class='st2'%20points='165.38,181.74%20184.58,216.46%20196.75,238.47%20225.19,189.2%20206.66,155.69%20193.83,132.46%20'/%3e%3c/g%3e%3c/svg%3e)
Windmill HubDiscourse
Communication API key and usernameCreate and read topics, posts, users and categories on a Discourse forum from any Windmill script, flow or app.
Set up in 3 steps
Create an API key
As a Discourse admin, open Admin, then API, then Keys. Create one, choosing whether it acts as a single user or as any user.
Add the resource in Windmill
Open Resources, add a resource of type discourse. defaultHost is your forum's host, apiKey is the key, and apiUsername is the account the calls should act as — system for an admin-level key.
Run your first script
Fork any script below and read before writing anything. There are dozens here, so search by the verb you need.
Scripts
Building blocks, if none of the projects above fit. Fork one, run it, or call it as a step inside your own flow.
delete a single post
Updates a category
Update username
Update topic timestamp
Update the status of a topic
Update tag group
Update email
Update badge
Update avatar
Update a user
Update a topic
Update a single post
Update a group
Suspend a user
Silence a user
Show category
Set notification level
Send password reset email
Send download backup email
Search for a term
Retrieves a list of categories
Retrieve a single post
Remove group members
Remove a topic
Refresh gravatar
Mark notifications as read
Log a user out
Lock a post from being edited
List topics
List replies to a post
Resource type
discourse — the shape of the credential every script on this page expects.
| Field | Type | Required | What it is |
|---|---|---|---|
| apiKey | string | No | API key retrieved from Discourse. |
| apiUsername | string | No | API username retrieved from Discourse. |
| defaultHost | string | No | Base URL of the Discourse instance. |
Questions
What does apiUsername change?
Who the call is made as. Posts and topics are attributed to that account, and it is what Discourse checks permissions against — a key alone does not identify a user.
Is my key stored on the hub?
Never. It lives only in your own Windmill workspace, encrypted at rest.