If at any point you require assistance with the below steps, please reach out to Beekeeper Support.
Integration Summary
Beekeeper’s integration with Slack currently supports the following use cases:
-
Share Messages from a Slack Channel to a Beekeeper Stream at the click of a button. Comments and likes will also be shared between the platforms.
- Send Beekeeper Form submissions directly to a Slack Channel.
Requirements
- You need to have access to a user with Global Admin permissions in the Beekeeper tenant you want to configure the integration for.
-
You need to know the Slack Team ID that you want to connect.
To get the Slack Team ID, log into the workspace on a web browser. Copy and save the part of the URL that comes after the letter ‘T' and before the next ‘/’. For example, in the URL https://app.slack.com/client/T028MTFUQEQ/C028107GFHD, “T028MTFUQEQ” is the Team ID.
Currently, only one Slack workspace can be connected to one Beekeeper tenant.
Installing the Beekeeper app in Slack
-
Log into the Slack workspace you want to integrate with Beekeeper.
-
Go to apps, type ‘Beekeeper’ in the search bar and select the Beekeeper App
-
Click on the button Add to Slack
-
Select the Slack channel you would like to be synced with Beekeeper and click Allow.
-
Now you should see the text: “Successfully saved slack authorization token”.
Installing the Slack app in the Beekeeper Marketplace
- In the Beekeeper admin Dashboard, navigate to Extensions > Marketplace
-
Type 'Slack' in the search bar and click on the Slack app
-
Click on Install
-
After the app has been installed, click on Configuration
-
<span">In the configuration field, add your Slack workspace ID as shown below:
{
"externalTenantId": "Insert your Slack Team ID here"
}
Important: please ensure that the tenant ID is inserted within the quotation marks ("").
- Click Validate & Save
If you see a green notification saying that the app has been configured, it means that the process was successful. Once you have configured the integration, you can do a test run. You can find the step-by-step instructions here.
Optional: Send Beekeeper Forms Submissions to Slack
You can set up the integration to automatically send Beekeeper Forms submissions to a channel of your choice in Slack. Form submissions are posted to Slack anonymously.
Configuring this functionality is optional. You can have multiple forms connected to one Slack workspace.
-
Create a form from the Beekeeper's Dashboard of your tenant. The exact instructions for creating forms are beyond the scope of this article. If you want to read the relevant documentation, you can click here.
There’s no limit to the number of questions you can put in the form. Just keep in mind that currently image & drawing question types are not supported by the integration (submitted answers will be shown as empty is Slack).
- Navigate to Extensions > Marketplace > Requested/Installed > Slack > Configuration
- Update the Slack app configuration by adding the formsConfig section:
{
"formsConfig": [
{
"channel": "Insert Slack Channel ID here",
"formId": "Insert Beekeeper Form ID here"
}
],
"externalTenantId": "Insert your Slack workspace ID here"
}
-
formId is the last part of your form's URL (e.g. https://your-company.beekeeper.io/dashboard/forms/dfcb0e6c-c48b-4a73-b5d7-9fe23a2c80b9, see screenshot below).
-
channel is a Slack channel ID to which the questions will be posted. It is the last part of Slacks URL. The Channel ID will start with C if the channel is public and G if the channel is private (e.g. https://app.slack.com/client/T028MTFUQEQ/C028107GFHD, see screenshot below).
-
formId is the last part of your form's URL (e.g. https://your-company.beekeeper.io/dashboard/forms/dfcb0e6c-c48b-4a73-b5d7-9fe23a2c80b9, see screenshot below).
-
If you wish to use a private channel for the integration, then the Beekeeper app bot has to be a member of the Slack channel. To invite the Beekeeper App bot to the channel, send the following message in the channel:
"/invite @beekeeper"
If you are connecting a public channel, you do not need to do this step. -
Repeat steps 3 & 4 for every Slack channel you want to receive Beekeeper Forms submissions. See below for an example configuration of multiple Beekeeper Forms connected to different Slack channels.
{
"externalTenantId": "Your Slack workspace ID", // REQUIRED
"formsConfig": [ // OPTIONAL, array should (but doesn't need to) contain at least one object (see format below), needed to configure sharing form submissions
{
"formId": "dfcb0e6c-c48b-4a73-b5d7-9fe23a2c80b9",
"channel": "C567EFGH8IJ"
},
{
"formId": "9281ca9a-559e-11eb-ae93-0242ac130002",
"channel": "C013VBKCX3P"
},
{
"formId": "06f5f75c-34d6-4309-a313-8e2a4c473695",
"channel": "C01AW9YT4G7"
}
]
} - Click on Validate & Save
- Share the Beekeeper Form, for example in a post or in Shortcuts.
Comments
0 comments
Please sign in to leave a comment.