English (UK)
Log in
Home
Home
Getting started
Get your whole company connected in as little as five weeks.
Choosing Workplace
Let's get into all of the reasons that Workplace is the right choice for your business.
Solutions
From levelling-up company communication to building a better culture, we're here to solve your toughest challenges.
Customer stories
Find out how organisations like yours are using Workplace to solve their most important business challenges.
Why Workplace
Why Workplace? Because it's familiar, mobile, secure, integrated and connects everyone. Why else?
Diversity & Inclusion
We're doing our bit for a better world by making sure that every employee feels seen, heard and valued.
Future of work
Learn how to take your first step into the metaverse with Meta's hardware and software solutions.
How can Workplace help you?
From levelling-up company communication to building a better culture, we're here to solve your toughest challenges.
Business communication
Our easy-to-use tools will make your most important messages unmissable, and your intranet inspirational.
Employee engagement
Ditch the email for more engaging company-wide conversations that give every employee a voice.
Strengthen culture
Show people you're committed to culture by empowering everybody to be the best version of themselves.
Getting connected
Bring your entire organisation together on Workplace, even if they don't have an email address.
Frontline workers
61% of frontline managers say there's a disconnect in communication with head office. We help close the gap.
Remote and hybrid working
Whether they're working from home or the office, Workplace keeps your employees connected to your company's culture.
Browse all
Organisations of all shapes and sizes are gaining a competitive edge with Workplace. Find your favourite story.
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 of 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 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 of the answers that you need from our customer support.
Security
    Customer stories
    Workplace for Good
      Getting started
        Interactive Demo
          Pricing plans
            Forrester ROI Study
              Events & Webinars
                E-books & Guides
                  Newsroom
                    Become a partner
                      Service & Reseller Partners
                        Integrations partners
                          Start using Workplace
                            Mastering Workplace features
                            Workplace use cases
                              Workplace Academy
                                Customer communities
                                  English (UK)

                                  Integrations > Custom Integrations



                                  Learn how to integrate other tools in your Workplace instance.
                                  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.