Workplace from Meta is going away. You will be able to continue using Workplace until August 31, 2025. Visit our Help Center to find out more.
English (US)
Log in
Home
Home
    Security
    Security is at the heart of everything we do, with world-class infrastructure and features to keep your company safe.
    RESOURCES
    Everything you need to transform the way you work with Workplace.
          Start Using Workplace
          From helpful tutorials to in-depth launch guides and toolkits, get all the resources you need for a quick and easy launch.
          Work Academy
          Discover new ways to use Meta for Work and best practices to help you work smarter.
          Podcasts
          Listen to our Pioneer Podcasts to hear some of our favorite success stories from our biggest champions.
          TECHNICAL RESOURCES CENTER
          Get help with setting up Workplace, managing domains and other technical issues.
          Mastering Workplace Features
          Ready to become a Workplace pro? Learn all the ins-and-outs of our key features with in-depth guides, step-by-step user instructions and resource hubs.
          Technical Resources
          You don't have to be an IT genius to launch Workplace, but if you are then these technical resources are for you.
          Help Center
          Find step-by-step instructions and answers to frequently asked questions.
          Support
          Still can't find what you're looking for? Get in touch with a team of experts for more hands-on support.
          News Archive
          Workplace innovations, feature announcements and product updates.
          Set up Guides
          From adding a domain to inviting users, follow this step-by-step guide to set up your Workplace.
          Domain Management
          Find out why domain management matters - and how to do it properly.
          Workplace Integrations
          Discover how to bring all your tools together. Something missing? Learn how to build your own integrations.
          Account Management
          Keep your Workplace up to date by creating, maintaining or deactivating user accounts.
          Authentication
          Make sure you only give access to the right people by integrating with your current identity solutions.
          IT Configuration
          Learn how to keep Workplace running smoothly with info on networks, email whitelisting and domains.
          Account Lifecycle
          Understand the process of inviting members of your organization to claim their accounts.
          Security and Governance
          Get the lowdown on how we keep your people and information safe on Workplace with added technical terminology.
          Workplace API
          Learn how you can automate and integrate your custom solutions with Workplace using our API.
          Getting started
          From launching Workplace to paying for it, learn more about those crucial first steps.
          Using Workplace
          This is where we reveal the hidden depths Workplace has to offer with tips and info on key features.
          Managing Workplace
          Got a specific question about managing content, data or employees? This is the place to ask it.
          IT and Developer Support
          Looking for answers to more technical questions about security, integration and the like? Start here.
          Support
          Still can't find what you're looking for? Get in touch with a team of experts for more hands-on support.
          Get in touch
          Need help with your Workplace account? Fill out this form to get all the answers you need from our customer support.
          Security
          Resources
          Security
            Start Using Workplace
              Mastering Workplace Features
              Technical Resources
              Work Academy
                Podcasts
                  Help Center
                  Support
                  English (US)
                  Log in

                  Integrations > Chat Bots



                  Learn how to integrate other tools in your Workplace instance.

                  Contents

                  Overview

                  A Chat Bot is a type of Custom Integration that Workplace users in your company can interact with via Workchat. It allows to automate certain actions and speed up some processes. The possibilities are infinite but the most popular use cases are covered in this document.

                  Here we will learn how to create your own bot in two steps: Configuring a bot on Workplace and Deploying it in your server(s).

                  To have more details about integrations and configurations in general, you can refer to this documentation.

                  Configuring a bot

                  Configuring a chat bot on Workplace

                  The first step to create a chat bot is configuring it on Workplace. To do so, you need to log in on Workplace as an Administrator who has the permission to change company settings and configure integrations. Once you're logged in you can complete the following steps:

                  1
                  Go to the Admin Panel and navigate to the Integrations section.

                  2
                  Click the Create Custom Integration button.

                  3
                  In the dialog, enter a Name and a Description for your integration. Ideally, the name will be as descriptive as possible and you will also upload a logo for the bot since this is going to be visible to the end users.

                  4
                  Click the Create button.

                  Once you have created the bot, you can proceed to configure the rest of it.

                  Basic configuration

                  In the Integrations section of the Admin Panel, click the name of the bot to be configured. The basic details you need to pay attention to are these:

                  5
                  Create an Access token for your bot, copy it and save it in a secure place.
                  This token will be sent in the API requests that your bot will generate so Workplace can verify that they come from your bot.

                  6
                  Make sure the bot is Enabled and Discoverable.
                  If the bot is not discoverable, users won't be able to interact with it. You may want to enable it later in the process once the rest is configured, but don't forget to do it before launching it.

                  Permissions

                  In the configuration screen of the integration, there is a section called Pemissions where you can choose the permissions that your bot will need access to.

                  7
                  Make sure that at least the "Message any member" permission is ticked.
                  Additionally, you may want to tick other permissions you may need for your bot to work, i.e. if your bot needs to retrieve the profile of users from Workplace, you will need to tick the "Read work profile" permission.

                  8
                  Click the Save button to persist the changes.

                  Webhooks

                  Another section you will need to configure for a chat bot is Webhooks. Webhooks allow you to subscribe to specific events and receive updates in real time. When a change/event occurs in Workplace (i.e. a user messages your bot), an HTTPS POST request is sent to a callback URL for each custom integration app that's subscribed to the relevant webhook topic.

                  Before continuing with this configuration, make sure that you deploy the code of the bot in your web server. More info here.

                  9
                  Expand the "Page" topic.

                  10
                  Make sure that at least "messages" and "messaging_postbacks" events are ticked.
                  These events will allow us to know when a user sends a message to our bot and when the user interacts with one of the buttons that our bot may have.

                  11
                  Click the Save button to persist the changes.

                  Security

                  The last section of the configuration of the bot is Security. Although this configuration is not strictly necessary for your bot to work, we highly recommend that you configure it before launching the bot to production.

                  12
                  (Optional) Enable the Require app secret proof option.
                  This will require the app secret proof and the app secret time when your server sends the API requests to Workplace.

                  13
                  (Optional) Add the public IPs of your servers to the Server IP allow list so only these servers are allowed to send request with your bot Access token.
                  Deploying a bot

                  Deploying a chat bot in your server

                  The second step to create a chat bot is deploying the code of the bot in your server. To do so, you need to deploy some code in a web server of your own.

                  We have created some bot samples that can be copied as they are, just replacing your tokens in the code. You can find them in the following links:

                  • Helpdesk Bot: Bot to automate Helpdesk requests for IT from users.
                  • Recognition Bot: Bot to automate recognition among users.
                  • HR FAQ Bot: Bot to provide easy access to HR FAQs to your users.