Quick Start

The quickest way to get up and running with Actions is to just have a go! The following sections will outline how to create your first action using a simple "Hello World" style command. We want the command to run when a user sends a command such as !hello or /hello with the output being "Hello X, how are you?"

Creating An Action

1. Login to the Modr8 platform website

2. Select "Manage" against your bot profile

3. Select the "Actions" button on your chat profile

4. Click the "Create" button on the "Create A New Action" card

5. Provide a name for your action so it is easier to find later by adding it to the "Strategy Name" text box

6. "Executes For" allows you to change permissions of when the action will run, we will leave it as is for now.

7. "Active" is a switch to turn the action off or on, leave this enabled

8. "Execution Probability" is a % chance for the action to be run on every event received. Leave this as 100%

Header information added in for our Hello World example

Now that the main header information of the action is set up we will move on to adding in conditions.

Adding Conditions

Conditions define what must happen for the action outcomes to run. In our Hello World example we want it to run when a message is sent to the chat that starts with !hello or /hello.

1. In the "Property" drop down select "Message Text" as we want to match message text

2. In the "Match" drop down select "Starts With" as we want to match the start of a message

3. In the "Match Value" text box add the text /hello

4. Click "Add Condition" button as we want to add another condition for the command to run

5. Complete steps 1 -3 again in the new condition that opens up but add !hello to the "Match Value" this time.

6. Switch the drop down that says "Match All Conditions" to read "Match Any Condition"

Conditions to execute our Hello World command are added in

Now we have defined some conditions for our action to run which are when a message is sent to the chat that starts with "/hello" or "!hello"

Adding Action Outcomes

When the conditions are met, we said we wanted to issue a message to the user. We will now begin adding the text in using our action outcomes.

1. Scroll down to "Action Groups"

2. In the "Execute Action" drop down select "Send Message"

3. In the "Message Text" area that opens up add "Hello {{o_user}}, how are you?"

4. Check the tick box "Delete After Timeout"

5. Click "Save Changes"

Creating our Hello World command action to send a message to the user

In your chat with your bot you should now be able to send either /hello or !hello and see your action running.

Running our Hello World example command built using Modr8 actions

In this tutorial we have simply replicated what our command module can already do, but hopefully with all of the various options you have seen it is apparent how much customisation you can do!

Actions are a great way of solving the complex use-cases every community has where Modr8 does not have a generic setting you can use actions to do exactly what you need.