Discourse Automation Plugin

discourse-automation is a plugin for to let you automate actions on your discourse Forum

Installation

Follow Install a Plugin how-to from the official Discourse Meta, using git clone https://github.com/discourse/discourse-automation.git as the plugin command.

Usage

Triggerable.add(:on_cake_day) do
  placeholder(:target_username, 'target_username')

  provided([:target_username])

  field(:group, component: :group)
end

Endpoints

Api call

An automation can be triggered through an API call using the top level endpoint: POST /automations/:automation_id/trigger.json

An api key will be necessary to make the call:

post "/automations/1/trigger.json", {
  params: { context: { foo: :bar } },
  headers: {
    HTTP_API_KEY: "XXX"
  }
}

The params of the request will be given as parameter to the automation’s script.

Feedback