Workplace from Meta is going away. You will be able to continue using Workplace until 31 August 2025. Visit our Help Centre to find out more.
English (UK)
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.
            Workplace use cases
            See these tips, best practices and inspirational use cases to build a truly connected business on Workplace.
            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 favourite success stories from our biggest champions.
            TECHNICAL RESOURCES CENTRE
            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 Centre
            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.
            What's new in Workplace
            Stay up to speed with all the latest Workplace innovations, feature announcements and product updates.
            Setup 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 that 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 organisation 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 in this form to get all the answers you need from our customer support.
            Security
            Resources
            Security
              Start using Workplace
                Mastering Workplace features
                Workplace use cases
                  Technical resources
                  Work Academy
                    Podcasts
                      Help Centre
                      Support
                      English (UK)
                      Log in

                      Integrations > Custom Integrations



                      Learn how to integrate other tools in your Workplace instance.

                      Contents

                      Overview

                      Overview

                      Custom Integrations are used by Workplace customers for in-house development (or bespoke development for the sole use of a single Workplace customer) to integrate their own tools or software ecosystem with Workplace.

                      In this section, we will learn how to create and configure a Custom Integration on Workplace.

                      Creating an integration

                      Creating an integration

                      To create an integration, log in 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 to create an integration:

                      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.

                      4
                      Click the Create button.

                      Once you have created the integration, you can proceed to configure it.

                      Basic configuration

                      In the Integrations section of the Admin Panel, click the name of the integration to be configured. These are the fields you may find in the Integration details screen.

                      • Integration details: You can modify the Name, logo and description of the integration, see the App ID and App Secret, and create or reset the Access token of your integration.
                        The Access token is required to send any API request so Workplace can verify and validate that the integration is sending those requests. Saving the Access token in a secure place is highly recommended since it can be used to perform critical actions on Workplace, such as creating or deactivating user accounts (provided that the integration has the corresponding permissions).
                      • Visibility: You can enable or disable your integration. If it's disabled, the integration will not be able to make any API request.
                        You can also enable or disable its discoverability, which will make your integration appear in the list of available bots on Workplace.
                      • Last API request: You can view the last day that the integration made an API request and the number of requests made in the last seven days.
                      • Delete integration: You can delete the integration. This action is not reversible and will delete the integration and its associated content.

                      Permissions

                      In the configuration screen of the integration, there is a section called Pemissions in which you can choose the permissions that your integration will need access to. Below you have the list of permissions.

                      To learn more about the Custom Integration permissions, please visit the Developers Documentation.

                      Webhooks

                      Another section available to configure for each integration is Webhooks. Webhooks allow you to subscribe to specific events and receive updates in real time. When a change occurs in Workplace, an HTTPS POST request is sent to a callback URL for each custom integration app that's subscribed to the relevant webhook topic.

                      One example of a webhook can be receiving an update in the callback URL when a comment has been created in a post.

                      Topics
                      Webhooks are divided into topics, and you can set a different callback URL per topic. More info on the topics and subscriptions available can be found in the Developers Documentation.

                      Subscribing to a webhook
                      More info on how to subscribe and action a webhook can be found in the Developers Documentation.

                      Security

                      You can set two types configurations here:

                      • Server IP allow list, where you can allow list IP addresses to only admit API calls that come from those IP addresses.
                      • Require app secret proof, where you can enable an additional layer of security that will require you to pass the app secret details when making an API call.

                      Link preview

                      The last section of the configuration is Link preview, which is only used by integrations that want to implement previews for links/urls on Workplace. All details can be found in the Developers Documentation.

                      Examples

                      Examples

                      You can find some code samples in our Github repository, and some chat bot examples here.