Here you find the complete manual for the Rafflebot.
Contents
Installation
To install Rafflebot to your Slack workspace simply click on the "Add to Slack" button on the top right and follow the instructions.
Note that your user will need to have the rights for installing Slack apps in your workspace.
Getting started
To start the Rafflebot just enter the command /raffle
in any channel on Slack and the bot will appear showing the main menu. You can then navigate the app by through buttons and menus.
In the main menu you will see a list of all current raffles in your workspace. Those are raffles that are currently running, have completed recently (so you can still cehck the results) and raffles that you have created, but have not started yet.
- Open raffle: Click and choose a raffle from the drop down menu to open.
- Create raffle: Create a new raffle.
- Workspace settings: Update the global raffle settings for this workspace (installer only)
- Help: Open the manual in the web browser (this page)
- Refresh: Redraws the main menu
- Close: Closes the app
After the app is installed for the first time we strongly recommend to update the workspace settings to make sure it fits with your specific workspace.
You can configure the main settings for Rafflebot by clicking on "Workspace settings" in the main menu. Note that this button will only be available to the user who installed the app.
- Default Channel: The default channel is the default channel for raffle announcements and will be the preset for every new raffle. The default name is "general".
- Timezone Offset:Here you can set the timezone offset that will be used for all time entries, e.g. for Sweden wintertime you would set it to GMT+01:00.
No support for DST adjustments
Note that the app currently does not support DST adjustment, so the installer of this app will need to manually adjust the timezone offset when DST changes in your region.
Create a new raffle
To create a new raffle just open the app by entering /raffle
in any channel. Then click on "Create raffle".
A dialog will prompt you to enter the basic information for your new raffle. Note that you can change that information later if you whish:
- Title: The title for your raffle. The title will be always shown together with the raffle.
- Channel: The channel on Slack to post public announcements about this raffle (e.g. that a raffle has started). This can be a public or private channel.
- Due Date: Date & Time for when the automatic drawing of the raffle shall take place. This date must be in the future.
After you entered the basic information a new raffle will be created and you will automatically be shown the edit raffle menu.
Edit a raffle
In this screen you can shape and manage your raffle including adding prizes, editing its basic information starting it once your are ready to go. Note that only the owner of a raffle can access this screen about a raffle.
Note that a raffle can only be edited if its paused. But you can always pause a running raffle to make changes if needed.
The screen will show the basic information about the raffle, how many people have already joined (if any) and the list of prizes a raffle has.
- Edit prize: Edit an existing prize. A dialog will open for entering the details about the new prize. See here for details
- Remove prize: Removes an existing prize. Note that this action can not be undone.
- Add prize: For adding a new prize to your raffle. A dialog will open for entering the details about the new prize. See here for details
- Add generic prize: For adding a set of generic prizes to your raffle. See generic prices for details. See here for details
- Edit raffle: Here you can update the basic information for your raffle like title, channel and due date.
- Delete raffle: This option allows you to delete the current raffle altogether. Note that this action can not be undone.
- Start raffle: This will start the raffle and post a promotion message in the raffle channel.
- Go to Main: To ready to the main menu.
- Help: Opens the manual in the web browser (this page)
- Refresh: Redraws the whole screen.
- Close: Closes the app
Add/Edit prize
Once you click on "Add price" or "Edit price" a dialog will open that will allow you to create a new prize or edit an existing one.
- Title: A meaningful title describing the prize.
- Description: A detailed description of the prize (optional).
- Image URL: A public link to an image representing the prize (optional)
Add generic prizes
Once you click on "Add generic prices" a dialog will open that will allow you to add a set of generic prizes to your raffle. Generic prizes all have the same title, (optional) description and (optional) image. So if you raffle contains a set of similar prizes (e.g. 10 x $10 amazon gift), this feature can be helpful.
- Title: A meaningful title describing the prize.
- Description: A detailed description of the prize (optional).
- Image URL: A public link to an image representing the prize (optional)
- Quantity: Number of generic prizes to be added to your raffle
- Add generic number?: Choose yes if you want to add 1, 2, 3, ... to the title of each prize.
Running a raffle
One your finished defining your raffle with all the prizes and the due date just click on "Start raffle" to activate it. An automatic announcement message about the raffle will be posted in the configured channel to inform all members of that channel about the raffle.
While your raffle is running you still have the ability to manage it:
- Enter raffle: To enter the current raffle.
- Leave raffle: To leave the current raffle.
- Pause raffle: If you want to make any changes to your raffle you first need to pause it. An automatic announcement message will be posted informing that the raffle has been pause and you will be again able to edit it.
- Promote raffle: This will submit another announcement message about this raffle in the configured channel
- Show participants: Shows the list of all current participants of this raffle
- Conduct drawing: Allows you to immediately conduct the raffle drawing ahead of the scheduled date and time.
Joining a raffle
Once a raffle has started a announcement message is posted in the channel. Users will be able to join or leave the raffle by clicking on the corresponding buttons below the posted message.
- Enter raffle: To enter the current raffle.
- Leave raffle: To leave the current raffle.
Its also possible to join a running raffle from any other channel. Just enter /raffle
to open the raffle bot. Then choose one of the running raffles you like to join from the drop down menu. You will get a screen similar to the following example:
- Enter raffle: To enter the current raffle.
- Leave raffle: To leave the current raffle.
Conduct raffle drawing
The drawing of a raffle will be conducted automatically once the scheduled date and time is reached. Alternatively the raffle owner can manually start the drawing if he so chooses. The result showing which participant won which price will be posted in the configured channel:
Exception cases
Here is an overview of how exception cases will be handled:
- Each participant can win a maximum of one prize. If there are more prizes than participants than some prizes will have no winner.
- If a raffle has no participants at the date of the scheduled drawing the raffle will be paused and the will be owner informed.
- Should the bot no longer have access to the configured channel at the date of the scheduled drawing the raffle will be paused and the owner will be informed.