add intro documentation and user guide
This commit is contained in:
Tanmay Deep Sharma
@@ -0,0 +1,163 @@
|
||||
---
|
||||
title: Setting Up Facebook
|
||||
description: Configure Facebook Messenger integration for Chatwoot
|
||||
sidebarTitle: Facebook
|
||||
---
|
||||
|
||||
To use Facebook Channel, you have to create a Facebook app in the developer portal. You can find more details about creating Facebook apps [here](https://developers.facebook.com/docs/apps/#register).
|
||||
|
||||
## Prerequisites
|
||||
|
||||
1. A valid facebook account.
|
||||
2. A valid facebook page.
|
||||
|
||||
## Register A Facebook App
|
||||
|
||||
1. Go to [Facebook developer portal](https://developers.facebook.com/apps/) and click on the "Create App" button
|
||||
|
||||
|
||||
|
||||
2. Select the option "Other".
|
||||
|
||||
|
||||
|
||||
3. For the app type, choose "Business".
|
||||
|
||||
|
||||
|
||||
3. Enter basic details like the app name and email.
|
||||
|
||||
|
||||
|
||||
Once you register your Facebook App, you will have to obtain the `App Id` and `App Secret`. These values will be available in the app settings and will be required while setting up Chatwoot environment variables.
|
||||
|
||||
|
||||
|
||||
## Configuring the Environment Variables in Chatwoot
|
||||
|
||||
Configure the following Chatwoot environment variables with the values you obtained during the Facebook app setup. The `FB_VERIFY_TOKEN` should be a unique and secure string that you provide when configuring the Facebook app. Generate a random string and set it as the `FB_VERIFY_TOKEN`. Facebook will include this string in all verification requests.
|
||||
|
||||
Restart the Chatwoot server after updating the environment variables
|
||||
|
||||
```bash
|
||||
FB_VERIFY_TOKEN=
|
||||
FB_APP_SECRET=
|
||||
FB_APP_ID=
|
||||
```
|
||||
|
||||
## Configure Facebook Login
|
||||
|
||||
1. Add the Facebook Login product via the Facebook app dashboard.
|
||||
|
||||
|
||||
|
||||
2. Enable `Web OAuth Login`, `Login with Javascript SDK` and add your self-hosted domain to the `Allowed Domains for the JavaScript SDK` input.
|
||||
|
||||
|
||||
|
||||
## Configure the Facebook App
|
||||
|
||||
1. In the app settings, add your `Chatwoot installation domain` as your app domain.
|
||||
|
||||
|
||||
|
||||
2. In the products section in your app settings page, Add "Messenger"
|
||||
|
||||
|
||||
|
||||
3. Go to the Messenger settings and configure the call back URL
|
||||
|
||||
|
||||
|
||||
4. Provide the Callback URL as `{your_chatwoot_installation_url}/bot` and the Verify token as `FB_VERIFY_TOKEN` from your environment variable.
|
||||
|
||||
|
||||
|
||||
5. Head over to Chatwoot and create a Messenger inbox. Choose a page for which your Facebook developer account has admin access to. Please refer to this [guide](https://www.chatwoot.com/hc/user-guide/articles/1677778588-how-to-setup-a-facebook-channel) for more details on creating a Messenger inbox in Chatwoot.
|
||||
|
||||
## Testing the Facebook channel
|
||||
|
||||
Until the application is approved for production, Facebook wouldn't send the new messages on your page to Chatwoot.
|
||||
|
||||
To test the changes until the app is approved for production. Follow the steps
|
||||
|
||||
1. Head over to the messenger section in your app settings page, in Facebook developers.
|
||||
|
||||
|
||||
|
||||
2. Click `Add or remove pages` and connect the page which you choose while creating the Chatwoot Messenger inbox.
|
||||
|
||||
|
||||
|
||||
3. After connecting the pages, Click on `Add subscriptions` from the connected page.
|
||||
|
||||
|
||||
|
||||
4. Subscribe to the following fields and save the subscription.
|
||||
|
||||
```
|
||||
messages
|
||||
messaging_postbacks
|
||||
message_deliveries
|
||||
message_reads
|
||||
message_echoes
|
||||
```
|
||||
|
||||
|
||||
|
||||
4. Send a message to the connected page from your Facebook account and it should appear in Chatwoot now.
|
||||
|
||||
## Going into production.
|
||||
|
||||
Before you can start using your Facebook app in production, you will have to get it verified by Facebook. Refer to the [docs](https://developers.facebook.com/docs/apps/review/) on getting your app verified.
|
||||
|
||||
Obtain advanced access to the required permissions mentioned below for your Facebook app
|
||||
|
||||
```
|
||||
pages_messaging
|
||||
pages_show_list
|
||||
pages_manage_metadata
|
||||
business_management
|
||||
pages_read_engagement
|
||||
```
|
||||
|
||||
<Warning>
|
||||
Make sure your facebook app subscription version is 17.0, we have updated the FB subscription with the latest version, so change the permission subscription version under the facebook app webhooks option.
|
||||
</Warning>
|
||||
|
||||
## Developing or Testing Facebook Integration in your machine
|
||||
|
||||
Install [ngrok](https://ngrok.com/docs) on your machine. This will be required since Facebook Messenger API's will only communicate via https.
|
||||
|
||||
```bash
|
||||
brew cask install ngrok
|
||||
```
|
||||
|
||||
Configure ngrok to route to your Rails server port.
|
||||
|
||||
```bash
|
||||
ngrok http 3000
|
||||
```
|
||||
|
||||
Go to the Facebook developers page and navigate into your app settings. In the app settings, add `localhost` as your app domain.
|
||||
In the Messenger settings page, configure the callback url with the following value.
|
||||
|
||||
```bash
|
||||
{your_ngrok_url}/bot
|
||||
```
|
||||
|
||||
Update verify token in your Chatwoot environment variables.
|
||||
|
||||
You will also have to add a Facebook page to your `Access Tokens` section in your Messenger settings page.
|
||||
Restart the Chatwoot local server. Your Chatwoot setup will be ready to receive Facebook messages.
|
||||
|
||||
## Facebook API version
|
||||
|
||||
We support facebook API version v13.0 going forward, which you can update in the facebook app advanced settings.
|
||||
|
||||
|
||||
## Test your local Setup
|
||||
|
||||
1. After finishing the set-up above, [create a Facebook inbox](https://www.chatwoot.com/hc/user-guide/articles/1677778588-how-to-setup-a-facebook-channel) after logging in to your Chatwoot Installation.
|
||||
2. Send a message to your page from Facebook.
|
||||
3. Wait and confirm incoming requests to `/bot` endpoint in your ngrok screen.
|
||||
@@ -0,0 +1,219 @@
|
||||
---
|
||||
title: Instagram via Facebook Login
|
||||
description: Set up Instagram integration using Facebook Login authentication
|
||||
sidebarTitle: Instagram via Facebook Login
|
||||
---
|
||||
|
||||
<Note>
|
||||
We recommend Instagram Business Login as the preferred authentication method, as it provides simpler configuration and a better developer experience. Please refer to this [guide](./instagram-via-instagram-business-login) for more details. We will be stopping the support for Instagram via Facebook Login in the future from v4.1 onwards.
|
||||
</Note>
|
||||
|
||||
## Prerequisites
|
||||
|
||||
1. A valid facebook account.
|
||||
2. A valid facebook page.
|
||||
3. A valid instagram professional account.
|
||||
|
||||
## Register A Facebook App
|
||||
|
||||
To use Instagram Channel, you have to create a Facebook app in the developer portal. You can find more details about creating Facebook developer app [here](./facebook-channel-setup).
|
||||
|
||||
1. Click on the "Create App" button
|
||||
|
||||
|
||||
|
||||
2. Select the option "Other".
|
||||
|
||||
|
||||
|
||||
3. For the app type, choose "Business"
|
||||
|
||||
|
||||
|
||||
3. Enter basic details like the app name and email.
|
||||
|
||||
|
||||
|
||||
Once you register your Facebook App, you will have to obtain the `App Id` and `App Secret`. These values will be available in the app settings and will be required while setting up Chatwoot environment variables.
|
||||
|
||||
|
||||
|
||||
## Configuring the Environment Variables in Chatwoot
|
||||
|
||||
Configure the following Chatwoot environment variables with the values you obtained during the Facebook app setup. The `IG_VERIFY_TOKEN` should be a unique and secure string that you provide when configuring the Instagram app.
|
||||
|
||||
Restart the Chatwoot server after updating the environment variables
|
||||
|
||||
```bash
|
||||
IG_VERIFY_TOKEN=
|
||||
FB_APP_SECRET=
|
||||
FB_APP_ID=
|
||||
```
|
||||
|
||||
## Configure the Facebook App
|
||||
|
||||
1. In the app settings, add your "Chatwoot installation domain" as your app domain.
|
||||
|
||||
2. Add the "Instagram Graph API" product via the Facebook app dashboard.
|
||||
|
||||
3. Go to the app settings and select "Webhooks". From there, choose Instagram and click on the "Subscribe to this object" button.
|
||||
|
||||
4. Provide the Callback URL as `{your_Chatwoot_installation_url}/webhooks/instagram` and the Verify token as `IG_VERIFY_TOKEN` from your environment variable.
|
||||
|
||||
|
||||
## Connect the facebook page with instagram account
|
||||
|
||||
1. Go to [Facebook pages](https://www.facebook.com/pages/?category=your_pages) and select your page and open the settings
|
||||
|
||||
|
||||
|
||||
2. Go to "Linked accounts" and connect your instagram professional account.
|
||||
|
||||
|
||||
|
||||
3. Select the option "Business"
|
||||
|
||||
|
||||
4. Select the instgram account category
|
||||
|
||||
|
||||
|
||||
5. If everything is okay, you will see the message "Instagram connected."
|
||||
|
||||
|
||||
|
||||
## Create Instagram Inbox in Chatwoot
|
||||
|
||||
1. Head over to Chatwoot and create a Messenger inbox. Please refer to this [guide](https://www.chatwoot.com/hc/user-guide/articles/1677829420-how-to-setup-an-instagram-channel) for more details on creating a Messenger inbox in Chatwoot.
|
||||
|
||||
So whenever you receive any message on Instagram, it will redirect to your Facebook page.
|
||||
|
||||
## Testing the Instagram channel
|
||||
|
||||
Until the application is approved for production, Facebook wouldn't send the new messages on your instagram to Chatwoot.
|
||||
To test the changes until the app is approved for production. Follow the steps
|
||||
|
||||
1. Create a Test app for your app.
|
||||
|
||||
|
||||
|
||||
2. Add the `Instagram Graph API` product via the Facebook app dashboard.
|
||||
|
||||
|
||||
3. Go to the app settings and select "Webhooks". From there, choose Instagram and click on the "Subscribe to this object" button.
|
||||
|
||||
|
||||
4. Provide the Callback URL as `{your_chatwoot_installation_url}/webhooks/instagram` and the Verify token as `IG_VERIFY_TOKEN` from your environment variable.
|
||||
|
||||
|
||||
5. Open the test app and add extra product for the test app: Instagram Basic Display
|
||||
|
||||
|
||||
|
||||
6. In the app settings, add the platform "Website" and give `Site URL` as your installation URL.
|
||||
|
||||
|
||||
|
||||
7. Head over to the Instagram Basic Display section and create a new app.
|
||||
|
||||
|
||||
|
||||
8. Add Instagram Testers by clicking "Add or Remove Instagram Testers" button.
|
||||
|
||||
|
||||
|
||||
9. Make sure that you have selected the role `Instagram Tester` while creating a new tester.
|
||||
|
||||
|
||||
|
||||
10. Click on Edit subscriptions under Webhook > Instagram and subscribe to the following,
|
||||
|
||||
```
|
||||
message_reactions
|
||||
messages
|
||||
messaging_seen
|
||||
```
|
||||
|
||||
|
||||
|
||||
<Note>
|
||||
You should do this step for both normal and test apps.
|
||||
</Note>
|
||||
|
||||
1. Head over to Chatwoot and create a Messenger inbox. Please refer to this [guide](https://www.chatwoot.com/hc/user-guide/articles/1677829420-how-to-setup-an-instagram-channel) for more details on creating a Messenger inbox in Chatwoot.
|
||||
2. Send a message to the connected Instagram account from Instagram Testers, and it should appear in Chatwoot now
|
||||
|
||||
## Going into production.
|
||||
|
||||
Before you can start using your Facebook app in production, you will have to get it verified by Facebook. Refer to the [docs](https://developers.facebook.com/docs/messenger-platform/instagram/app-review) on getting your app verified.
|
||||
|
||||
Obtain advanced access to the required permissions mentioned below for your Facebook app
|
||||
```
|
||||
instagram_manage_messages
|
||||
instagram_basic
|
||||
pages_show_list
|
||||
pages_manage_metadata
|
||||
pages_messaging
|
||||
business_management
|
||||
```
|
||||
|
||||
<Note>
|
||||
If your facebook app's version is more than 7.0 then you will need extra permission according to facebook's updated policy. Make sure you get permission for.
|
||||
```
|
||||
pages_read_engagement
|
||||
```
|
||||
</Note>
|
||||
|
||||
## Developing or Testing Facebook Integration in your machine
|
||||
|
||||
Install [ngrok](https://ngrok.com/docs) on your machine. This will be required since Facebook Messenger APIs will only communicate via https.
|
||||
|
||||
```bash
|
||||
brew cask install ngrok
|
||||
```
|
||||
|
||||
Configure ngrok to route to your Rails server port.
|
||||
|
||||
```bash
|
||||
ngrok http 3000
|
||||
```
|
||||
|
||||
Go to the Facebook developers page and navigate into your app settings. Add `localhost` as your app domain and add a privacy policy URL in the app settings.
|
||||
In the Webhook > Instagram settings shown in the above image, configure the callback url with the following value.
|
||||
|
||||
```bash
|
||||
{your_ngrok_url}/webhooks/instagram
|
||||
```
|
||||
|
||||
Update verify token in your Chatwoot environment variables.
|
||||
|
||||
You will also have to add a Facebook page to your `Access Tokens` section in your Messenger settings page.
|
||||
Restart the Chatwoot local server. Then, your Chatwoot setup will be ready to receive Facebook messages.
|
||||
|
||||
## Test your local Setup
|
||||
|
||||
1. After finishing the setup above, [create a Messenger inbox](https://www.chatwoot.com/hc/user-guide/articles/1677778588-how-to-setup-a-facebook-channel) after logging in to your Chatwoot Installation.
|
||||
2. Send a message to your Facebook Page from your Instagram account.
|
||||
3. Wait and confirm incoming requests to `/webhooks/instagram` endpoint in your ngrok screen.
|
||||
4. You can also verify your callback URL by clicking on Test for the subscribed Instagram fields.
|
||||
Go to webhook Instagram and click on Test with `v11.0`
|
||||
|
||||
|
||||
<Note>
|
||||
You can have only one app connected to the Chatwoot for Instagram and Facebook combined as the Messenger platform is common. But suppose you want to have separate channels for Instagram and Facebook. In that case, you can have multiple Facebook pages inside your app that would be connected to Facebook users and Instagram users separately and then connected to the different inbox in the Chatwoot page.
|
||||
</Note>
|
||||
|
||||
## Checklist
|
||||
|
||||
1. Integrate the Facebook test app and Send a message from the Instagram tester to the connected account.
|
||||
2. Make sure your Instagram account is a business account.
|
||||
3. If the Instagram test account can receive the message and forward it to the webhook URL, then submit it for review.
|
||||
4. If the Instagram test account is not able to receive the message and forward it to the webhook URL
|
||||
- Check the logs if you are receiving the message to `{your-app-url}/webhooks/Instagram`
|
||||
- If the logs are present for the above endpoint, if there are any errors, then reach out to us. We will help you out.
|
||||
- If the logs aren't present for the above endpoint, then raise a bug for the Facebook team or follow this bug https://developers.facebook.com/support/bugs/468852858104743/
|
||||
5. If you are not facing the above issue and can get the message, but the review isn't passing, then reach out to the reviewer.
|
||||
- When your app gets rejected, open the rejected submission. You can see the messenger icon in the bottom right corner to support you with your rejected review.
|
||||
- You can talk to the support team and ask your questions about the submission and the reason for the rejection.
|
||||
6. If your test app passed the review, it's good to go into production.
|
||||
7. If you face an issue on production that you cannot receive the messages, then reach out to us with the error logs.
|
||||
+110
@@ -0,0 +1,110 @@
|
||||
---
|
||||
title: Instagram via Instagram Business Login
|
||||
description: Set up Instagram integration using Instagram Business Login authentication (recommended method)
|
||||
sidebarTitle: Instagram via Instagram Business Login
|
||||
---
|
||||
|
||||
<Note>
|
||||
Please ensure you have installed version v4.1 or above. If not, please refer to this [guide](./instagram-channel-setup) for the Facebook Login method.
|
||||
</Note>
|
||||
|
||||
## Prerequisites
|
||||
|
||||
1. A valid facebook account.
|
||||
2. A valid instagram professional account.
|
||||
|
||||
## Register A Facebook App
|
||||
|
||||
To use Instagram Channel, you have to create a Facebook app in the developer portal. You can find more details about creating Facebook apps [here](./facebook-channel-setup).
|
||||
|
||||
1. Click on the "Create App" button
|
||||
|
||||
|
||||
|
||||
2. Select the option "Other".
|
||||
|
||||
|
||||
|
||||
3. For the app type, choose "Business"
|
||||
|
||||
|
||||
|
||||
4. Add app name and connect business account
|
||||
|
||||
|
||||
|
||||
5. Add Instagram product from the Home page.
|
||||
|
||||
|
||||
|
||||
## Configure Instagram settings for Chatwoot
|
||||
|
||||
1. Copy Instagram app ID and Instagram app secret
|
||||
|
||||
|
||||
|
||||
2. Add the Instagram app ID and Instagram app secret to your app config via `{Chatwoot installation url}/super_admin/app_config?config=instagram`
|
||||
|
||||
|
||||
|
||||
3. Configure Webhooks
|
||||
|
||||
Set the callback URL to `{your_chatwoot_url}/webhooks/instagram`. The verify token should match your `INSTAGRAM_VERIFY_TOKEN`, which can be configured through `app_config`
|
||||
|
||||
|
||||
|
||||
Subscribe to `messages`, `messaging_seen`, and `message_reactions` events.
|
||||
|
||||
|
||||
|
||||
<Note>
|
||||
To receive web hooks, app mode should be set to "Live".
|
||||
</Note>
|
||||
|
||||
4. Set up Instagram business login
|
||||
|
||||
Set Redirect URL as `{your_chatwoot_url}/instagram/callback`
|
||||
|
||||
|
||||
|
||||
5. Create a new Instagram tester account
|
||||
|
||||
## Create Instagram Inbox
|
||||
|
||||
Head over to Chatwoot and create a Instagram inbox. Please refer to this [guide](https://chatwoot.help/hc/user-guide/articles/1744361165-how-to-setup-an-instagram-channel-via-instagram-login) for more details on creating a Instagram inbox in Chatwoot.
|
||||
|
||||
## How to test the Instagram before going to live
|
||||
|
||||
1. Add Instagram Testers by clicking "Add People" button.
|
||||
|
||||
|
||||
|
||||
2. Make sure that you have selected the role Instagram Tester while creating a new tester.
|
||||
|
||||
|
||||
|
||||
## Going into production.
|
||||
|
||||
Before you can start using your Facebook app in production, you will have to get it verified by Facebook. Refer to the [docs](https://developers.facebook.com/docs/messenger-platform/instagram/app-review) on getting your app verified.
|
||||
|
||||
## Troubleshooting & Common Errors
|
||||
|
||||
### Insufficient Developer Role Error
|
||||
|
||||
Ensure the Instagram user is added as a developer: `Meta Dashboard → App Roles → Roles → Add People → Enter Instagram ID`
|
||||
|
||||
### API Access Deactivated
|
||||
|
||||
Ensure the **Privacy Policy URL** is valid and correctly set.
|
||||
|
||||
### Invalid request: Request parameters are invalid: Invalid redirect_uri
|
||||
|
||||
Please configure the Frontend URL. The Frontend URL does not match the authorization URL.
|
||||
|
||||
### Instagram Channel creation Error: Failed to exchange token
|
||||
|
||||
Please make sure that tester account has been added to the facebook app settings.
|
||||
|
||||
### 400: Session Invalid when connecting the instagram channel
|
||||
|
||||
This might be issue from facebook side. Please try again after some time.
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
title: Setting Up Linear Integration
|
||||
description: Configure Linear integration to track issues and features from Chatwoot
|
||||
sidebarTitle: Linear
|
||||
---
|
||||
|
||||
Setting up Chatwoot Linear integration involves 5 steps.
|
||||
|
||||
1. Create a Linear app in the [developer portal](https://linear.app/settings/api/applications/new).
|
||||
2. Add necessary details and save the app.
|
||||
3. Configure Chatwoot with the `Client ID` and `Signing Secret` obtained from the Linear app.
|
||||
4. Open Chatwoot UI, navigate to integrations, select Linear, and click connect.
|
||||
5. Voila! You should now be able to use Linear in your Chatwoot account.
|
||||
|
||||
## Register and configure the Linear app
|
||||
|
||||
To use Linear Integration, you need to create a Linear app in the developer portal. You can find more details about creating Linear apps at the [Linear developer portal](https://developers.linear.app/docs/oauth/authentication).
|
||||
|
||||
1. Create a Linear app.
|
||||
2. Obtain the `Client ID` and `Client Secret` for the app and configure it in your app config via `{Chatwoot installation url}/super_admin/app_config?config=linear`
|
||||
3. The callback URL should be `{Chatwoot installation url}/linear/callback`.
|
||||
4. Toggle the `Public` switch to make the app public.
|
||||
|
||||
|
||||
|
||||
## Configure Linear app config
|
||||
|
||||
Obtain the `Client ID` and `Client Secret` for the app and configure it in your app config via `{Chatwoot installation url}/super_admin/app_config?config=linear`. These values will be available when you create the app in the developer portal.
|
||||
|
||||
```bash
|
||||
LINEAR_CLIENT_ID=
|
||||
LINEAR_SIGNING_SECRET=
|
||||
```
|
||||
|
||||
Restart the Chatwoot server.
|
||||
|
||||
<Note>
|
||||
Linear will only show up in the integrations section once you have configured these values and restarted the server.
|
||||
</Note>
|
||||
|
||||
## Connect Chatwoot with your Linear account
|
||||
|
||||
Follow this [guide](https://chatwoot.help/hc/user-guide/articles/1739949089-how-to-track-issues-and-features-with-linear-integration) to complete the Linear integration.
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
title: Setting Up Shopify Integration
|
||||
description: Configure Shopify integration to track orders and customer information from Chatwoot
|
||||
sidebarTitle: Shopify
|
||||
---
|
||||
|
||||
Setting up Chatwoot Shopify integration involves 5 steps.
|
||||
|
||||
1. Create a Shopify app in the [shopify partner dashboard](https://partners.shopify.com/).
|
||||
2. Add necessary details and save the app.
|
||||
3. Configure Chatwoot with the `Client ID` and `Client secret` obtained from the Shopify app.
|
||||
4. Open Chatwoot UI, navigate to integrations, select Shopify, and click connect.
|
||||
5. Voila! You should now be able to use Shopify in your Chatwoot account.
|
||||
|
||||
## Register and configure the Shopify app
|
||||
|
||||
To use Shopify Integration, you need to create a Shopify app in the [shopify partner dashboard](https://partners.shopify.com/). You can find more details about creating Shopify apps at the [Shopify developer portal](https://shopify.dev/docs/apps/build).
|
||||
|
||||
1. Create a Shopify app.
|
||||
|
||||
|
||||
|
||||
2. Obtain the `Client ID` and `Client Secret` for the app and configure it in your app config via `{Chatwoot installation url}/super_admin/app_config?config=shopify`
|
||||
|
||||
|
||||
|
||||
3. Configure the redirect URL as `{Chatwoot installation url}/shopify/callback` in app configuration.
|
||||
|
||||
|
||||
|
||||
<Note>
|
||||
Shopify will only show up in the integrations section once you have configured these values.
|
||||
</Note>
|
||||
|
||||
## Connect Chatwoot with your Shopify account
|
||||
|
||||
Follow this [guide](https://chatwoot.help/hc/user-guide/articles/1742395545-how-to-track-orders-with-shopify-integration) to complete the Shopify integration.
|
||||
@@ -0,0 +1,79 @@
|
||||
---
|
||||
title: Setting Up Slack Integration
|
||||
description: Configure Slack integration to receive Chatwoot conversations in Slack channels
|
||||
sidebarTitle: Slack
|
||||
---
|
||||
|
||||
Setting up Chatwoot Slack integration involves 5 steps.
|
||||
|
||||
1. Create a slack app in the developer portal.
|
||||
2. Add necessary permissions for the slack app.
|
||||
3. Configure Chatwoot with the `client ID` and `client Secret` obtained from the slack app.
|
||||
4. Open Chatwoot UI, navigate to integrations, Slack and click connect.
|
||||
5. Voila! You should be receiving new conversations in the #customer-conversations channel in Slack.
|
||||
|
||||
## Register a Slack app
|
||||
|
||||
To use Slack Integration, you have to create a Slack app in the developer portal. You can find more details about creating Slack apps at the [Slack developer portal](https://api.slack.com/).
|
||||
|
||||
Once you register your Slack App, you will have to obtain the `Client Id` and `Client Secret`. These values will be available in the app settings and will be required while setting up Chatwoot environment variables.
|
||||
|
||||
## Configure the Slack app
|
||||
|
||||
1. Create a Slack app and add it to your development workspace.
|
||||
2. Obtain the `Client Id` and `Client Secret` for the app and configure it in your Chatwoot [environment variables](/docs/self-hosted/configuration/environment-variables).
|
||||
3. Head over to the `OAuth & permissions` section under `features` tab.
|
||||
4. In the redirect URLs, Add your Chatwoot installation base URL.
|
||||
5. In the scopes section configure the given scopes for bot token scopes:
|
||||
- `channels:history`
|
||||
- `channels:join`
|
||||
- `channels:manage`
|
||||
- `channels:read`
|
||||
- `chat:write`
|
||||
- `chat:write.customize`
|
||||
- `commands`
|
||||
- `files:read`
|
||||
- `files:write`
|
||||
- `groups:history`
|
||||
- `groups:write`
|
||||
- `im:history`
|
||||
- `im:write`
|
||||
- `links:read`
|
||||
- `links:write`
|
||||
- `mpim:history`
|
||||
- `mpim:write`
|
||||
- `users:read`
|
||||
- `users:read.email`
|
||||
7. In the user access token section subscribe to: `files:read`, `files:write`, `remote_files:share`
|
||||
8. Head over to the `Events Subscriptions` section in the `Features` tab.
|
||||
9. Enable events and configure the given request url `{Chatwoot installation url}/api/v1/integrations/webhooks`
|
||||
10. Subscribe to the following bot events: `link_shared`, `message.channels`, `message.groups`, `message.im`, `message.mpim`.
|
||||
11. Add the installation URL as `domain` under the `App unfurl domains section` to display meta information about the conversation when the conversation URL is shared.
|
||||
12. Connect Slack integration on Chatwoot app and get productive.
|
||||
|
||||
## Configure the environment variables in Chatwoot
|
||||
|
||||
Obtain the `Client ID` and `Client Secret` for the app and configure it in your Chatwoot [environment variables](/docs/self-hosted/configuration/environment-variables).These values will be available under `Settings` > `Basic Information`.
|
||||
|
||||
```bash
|
||||
SLACK_CLIENT_ID=
|
||||
SLACK_CLIENT_SECRET=
|
||||
```
|
||||
|
||||
Restart the Chatwoot server.
|
||||
|
||||
<Note>
|
||||
Slack will only show up in the integrations section once you have configured these values and restarted the server.
|
||||
</Note>
|
||||
|
||||
## Connect Chatwoot with your Slack workspace
|
||||
|
||||
Follow this [guide](https://www.chatwoot.com/hc/user-guide/articles/1677774874-how-to-answer-conversations-from-slack) to complete the Slack integration.
|
||||
|
||||
## Testing your setup
|
||||
|
||||
1. Create a new conversation.
|
||||
2. Ensure that you are receiving the Chatwoot messages in the connected slack channel.
|
||||
3. Add a message to that thread and ensure that it is coming back on to Chatwoot.
|
||||
4. Add `note:` or `private:` in front of the Slack message to see if it is coming out as private notes.
|
||||
5. If your Slack member's email matches their email on Chatwoot, the messages will be associated with their Chatwoot user account.
|
||||
Reference in New Issue
Block a user