How to build a Holiday quiz bot

This help doc walks you through setting up and editing the Quiz of the Year bot template

Tom Gibby avatar
Written by Tom Gibby
Updated over a week ago

How to build a Holiday quiz bot

Quizzes are a fun and popular way of looking back at the last 12 months and can be scaled across large and distributed workforces with relative ease. By using bots on Workplace, it’s possible to allow everyone in a company to take part, from front line staff out on the field through to factory workers on their mobiles and HQ office staff working from desks. 

So, let’s show you how easy it is to build a fun, interactive quiz using bots on Workplace from Facebook.

Summary

  • Time to build: 60 minutes 

  • Skill level: Easy 

If you’re familiar with how the Holiday quiz bot works then scroll down to the next section, otherwise we suggest taking a look at this short overview video that will show you the key screens and features. 

What you need

In order to build this bot you will need: 

  • A trial account or log in for The Bot Platform 

  • Admin status on your Workplace instance so you can connect the bot

  • A computer that, ideally, is running Chrome

  • Some festive cheer. Because it’s the Holidays after all!  

Template instructions

Step 1: Creating an account

Ok, so the first thing we’re going to do is log into The Bot Platform. You can do this by clicking this link. Sign in using your TBP log in details. If you don’t have a TBP log in then you can sign up for a free trial using this link. Once you’ve done this you’ll need to verify your email. As we’re security conscious, we’ll use this as an opportunity to suggest all users enable 2FA too. 


Step 2: Launching the template

Once you’ve verified your email you’ll be logged in to your dashboard. If you’re a new TBP user then you’ll see a blank dashboard like the image below. As you build bots they would appear here. 

Click on the blue “Create a new bot” button. 

You’ll then see our template dashboard screen. There are a number of different templates you can choose and each has a ‘Learn more’ button that clicks through to more information about that particular use case. 

For the purpose of this tutorial, we’re going to click on the ‘Quiz of the year’ icon.

You’ll then be asked to name your bot. This is the name for how your bot on The Bot Platform. We will come to what your staff see when they use the bot when we connect it to Workplace in step 4. 

Type in a name for your bot, for example “2019 Company Quiz”, and click the blue ‘Save’ button. 

Congratulations - you have created your first bot! This isn’t live on Workplace yet, but you now have a template that you can start editing! 

Click on the blue “Customize your bot” button and you’ll be taken to the message menu. 

The message menu contains all the messages that make up a given bot. For the quiz template there is a 10 question quiz with correct and incorrect answers for each.


Step 3: Reviewing and editing the template

We’re going to start off with 'Welcome message - Start'. Click on the blue ‘edit’ button to open that particular message. 

The Welcome Message is the first message your staff will see when they start using the bot. It is made up of 2 message parts and 2 buttons. 

If you want to change any of the text, simply click into the text block and start typing. Once you’re done, click the blue ‘save’ button. You’ll then be redirected back to the message menu. 

The next message we’ll want to look at is called ‘Quiz of the year - Q1’. Scroll down to that message and then click the blue ‘edit’ button. 

This is the first question in your quiz. It consists of a GIF, a message that resets the user’s score, 1 message part and 3 quick replies containing possible answers. 

You’ll probably want to change some or all of these questions and answers We suggest writing out your quiz in advance so you can simply copy and paste in the new information for each message. 

We’re going to click on the ‘Switch to navigation’ button in the blue bar which allows us to click through the bot as if we were a user. This helps us understand the structure of the bot and get a feel for how to update the template. 

Once you’ve clicked the ‘Switch to navigation’ button the blue bar will turn orange. Scroll down to the bottom of the message with the three possible answers. 

This particular question is about Lady Gaga’s performance at the Oscars. There are then three buttons a user can press containing the possible answers. These are called Quick Replies. The maximum length of a quick reply title is 20 characters. 

When designing your quizzes try and keep the answers to less than 20 characters, but where this isn’t possible you can include the answer in the actual text along with a corresponding number or letter that goes in the quick reply. 

Eg. Press ‘Option 1’ for xxxxxx 

In the example here, we’re going to click the first option ‘Bad Romance’. This will take us to the message a user will see if they select that answer. 

In this message we can see we’re telling the user the correct answer is ‘Shallow’ and then asking them to click a button to go to the next question. Click the button to go to the next message and keep clicking through the quiz to familiarize yourself with how it’s put together. 

You’ll notice some of the questions don’t need to have 3 answers. Question 3, for example, only has 2 answers to choose from. 

You’ll see in question 5 that we say ‘Here’s question 5...’ at the top of the message. This is so staff know where they are in the quiz as they go through the questions. 

From question 7 onwards the quiz template is then blank. Keep clicking through an option until you get to the end of the quiz and see a message called ‘Quiz of the year - finish’. 

This is a variation message and contains a series of different responses that are shown based on the score a user has achieved in the quiz. 

For example, click on the ‘quiz result bad’ option in the right hand menu and you’ll see the message that is sent to staff who score less than or equal to 5 points out of 10. 

It includes a GIF, a text message part and two buttons that allow the staff member to try again or visit a Workplace Group to see the scores of their colleagues. Anyone who scores 6 or more out of 10 can share their score to this Workplace Group for their colleagues to see. 

If you click on the option that says ‘Quiz result perfect’ you’ll see what is sent to users who get a perfect score of 10 out of 10. 

Now we’ve clicked through the different messages in the template we want to go back to the beginning and start changing the questions and answers to the ones you’ve written for your company and workforce. 

Click on the ‘Messages’ button in the left hand menu and find the message called ‘Quiz of the year - Q1’. Then click the blue edit button to open the message. 

Type in the question that you want staff to see first in your quiz.

Now we’ve changed the question, we need to change the answers. Click on the cog icon in the quick replies and you’ll open a screen that looks like this.

We can see here that ‘Shallow’ is the correct answer because it has ‘1’ assigned to it and it links to a message called ‘Quiz of the year - Q1 - Correct’. 

Type in your correct answer in place of ‘Shallow’ and then replace the two incorrect options with your incorrect answers. 

Once you’ve done this, click the blue save button. 

You’ll then go back to the ‘Quiz of the year - Q1’ screen. Click the blue ‘save’ button. 

You’ll now be back in the message menu.

The next message we want to look for is called ‘Quiz of the year - Q1 - Correct’. 

Click into the text bubble and edit the message in line with the correct answer for your question. When you’re done, click the blue ‘save’ button. 

Now do the same for the message called ‘Quiz of the year - Q1 - Incorrect’. 

You’ll then need to repeat this process for each of your 10 questions and their correct and incorrect messages. 

Once you’ve added in all 10 questions, scroll down the left hand menu until you get to the ‘Settings’ section and click on ‘Get Started Message’. 

Change this text to be more relevant to your company or quiz, and then click the blue ‘save’ button. Once you’ve done this, click on the ‘Connect to Workplace’ button in the orange bar. 


Step 4: Connecting to Workplace

OK awesome, your Holiday quiz bot is pretty much finished! We’re now going to connect it to Workplace. 

Once you’ve clicked on the ‘Connect to Workplace’ button in the orange bar you’ll see a screen that asks you to connect your Workplace account. Click the blue ‘I am a Workplace Admin’ button. If you’re not an admin, you’ll need to involve someone from your company who is in order to add the bot to your Workplace instance.

Ensure all the boxes are ticked on the next screen giving your bot various permissions and then click the red ‘Next’ button at the bottom. 

You’ll then be redirected to Workplace’s website and asked which Workplace account you would like to use. Click on the correct one. 

Now we have the ability to customise how the bot will look to your staff and which groups on Workplace it has access to. 

We’ll start off with the bot name, description and icon. 

Click the ‘Customise’ button and enter the name you’d like your bot to appear as in the ‘Integration name’ section. 

Then update the description of the integration. Change it to something short and sweet like “Can you score 10/10 in our company quiz?!”. 

You can change the logo/icon of the bot too. For example, if you wanted the icon to be your company logo, or any quiz related icon - click the ‘Update logo’ button, add one from your computer and resize as appropriate. 

Then click the blue ‘Save button’. 

Now we need to select which groups have access to the bot. You can change this whenever you want, so our suggestion is to start off by connecting it to a test group or Workplace group that you and other Workplace admins or people you might work on the bot with are in. 

For example, you may have created a group on Workplace called “bot testing” or “Holiday quiz bot” that only a few people are a member of. 

Click the ‘Specific groups’ button and start typing the name of the group or groups you want to connect the bot to. This means only people in those groups will be able to find and access the bot. 

Once you’re ready to launch it to the whole company you can add more groups or change the settings to ‘All groups’. 

Once you’ve added the correct groups, click the blue ‘Add to Workplace’ button. 

Wait a few seconds and then you’ll be redirected back to The Bot Platform and you should now see a green bar at the top of your dashboard that says “Success! Your bot has been successfully connected to Workplace”.

Your bot is now connected to Workplace!! Easy, right! 


Step 5: Connecting to Groups

Now our bot is connected to Workplace, we can add in the functionality such as posting to groups or sending broadcasts. 

Click on the ‘Messages’ button in the left hand navigation menu. 

Scroll down until you find the message called ‘Share message’ and click on the blue edit button. 

The top message part of this message contains our ‘Post to group’ feature which shares people’s scores to a group on Workplace. This allows you to make the quiz social, let staff compete with colleagues and drive engagement. 

Click where it says ‘Quiz of the year scores’ and you’ll see a screen like the one below. 

Start typing in the name of Workplace group you want to share the scores to. This can be changed whenever you want. For now type in the name of the testing group you connected your bot to earlier. 

Start typing the name of the group. If it doesn’t appear, click the ‘Refresh groups’ button and it should appear. Then click the blue save button. 

You’ll then go back to the ‘Share message’ screen. Scroll down to the bottom message part and click on the cog where it says ‘See scores’. 

Replace the URL to open with the URL of the Workplace Group you’ve created where these scores will post to. Then click the save button. Then click the save button again in the ‘Share message’ screen. 

You will now be redirected back to the message menu and see an orange bar with a button that says “Push the changes live”. Because your bot is now connected to Workplace, changes that you make to your bot will only appear to users on Workplace when you click this button. 

Click the ‘Push the changes live’ button in the orange bar.

You’ll need to repeat this process for the messages called ‘Manage alerts - confirm opt-out’ and each of the variation responses for the bad, ok, good and perfect messages in ‘Quiz of the year - Finish’.

Once you’ve made these changes click the blue save button. Then scroll down on the left hand menu and click on the button that says ‘Persistent menu’ under the Settings section. 

Click on the cog in the ‘See Top Scores’ button and paste the correct Workplace Group URL here too. 

Your bot is now ready to use. Click on the name of the bot in the top left of the dashboard. In the image above we would click on the button that says ‘2019 Company Quiz’ with the Workplace icon next to it. 

Click on that and your bot will open in a new tab on your computer. Or, search for the name of your bot on Workplace Chat on your phone.

The screen you’ll see is the Get Started message you edited earlier. Click the ‘Get Started’ button at the bottom of your screen to start using the bot. 

Your bot is now working! Have a play with it and run through the flow.


Step 6: Sending broadcasts

We’re now going to set up the broadcasts. This allows you to send messages out to your staff inviting them to get involved in the company quiz. 

You can send broadcasts to all staff, members of specific Workplace groups or custom segments of staff. 

Click on the ‘Broadcasts’ button in the side navigation. You’ll see a screen like the one below. Click on the blue button that says “Create a broadcast”.  

In the section that says ‘Select the message to schedule’ start typing and then select ‘Welcome Message - start’. 

In the choose a target for your broadcast select ‘Workplace Groups’ and in the ‘Send to group(s)’ section start typing the name of the test group you set up earlier, or a group that has people in that you want to test or use the bot. 

If you don’t see the group when you start typing then click the ‘Refresh groups’ button and try again. 

Scroll down the page and click the ‘Date / time’ section. This will bring up a calendar. Select the day and time you want to send the broadcast. Or, if you want to send it now, click the ‘Set to now’ button. Then press the blue ‘Schedule’ button to save the broadcast. 

You’ll then be redirected to your Broadcasts menu where you can edit, test and delete scheduled broadcasts. 

And that’s it. You’ve now successfully built a fun, interactive quiz that anyone in your company can take part in and share their scores with their colleagues and peers. 

Congratulations! 

Did this answer your question?