Skip to content

Commit

Permalink
feat: linear integration setup docs (#529)
Browse files Browse the repository at this point in the history
* feat: add linear setup docs

* chore: update doc

* chore: update docs
  • Loading branch information
muhsin-k authored Mar 1, 2025
1 parent ad80c9e commit 98d2228
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 1 deletion.
1 change: 1 addition & 0 deletions config/sidebar/selfhosted.js
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ module.exports = [
"self-hosted/configuration/features/integrations/facebook-channel-setup",
"self-hosted/configuration/features/integrations/instagram-channel-setup",
"self-hosted/configuration/features/integrations/slack-integration-setup",
"self-hosted/configuration/features/integrations/linear-integration-setup",
],
},
{
Expand Down
3 changes: 2 additions & 1 deletion docs/self-hosted.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,8 @@ This guide will help you to install and setup a production ready Chatwoot.

- [Facebook App Setup](/docs/self-hosted/configuration/features/integrations/facebook-channel-setup)
- [Instagram App Setup](/docs/self-hosted/configuration/features/integrations/instagram-channel-setup)
- [Slack App](/docs/self-hosted/configuration/features/integrations/slack-integration-setup)
- [Slack](/docs/self-hosted/configuration/features/integrations/slack-integration-setup)
- [Linear](/docs/self-hosted/configuration/features/integrations/linear-integration-setup)

## Maintenance

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
sidebar_label: "Linear"
title: "Setting Up Linear Integration"
---

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.



![linear_app_domain](./images/linear/create-app.png)


## 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.
## 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 comments on commit 98d2228

Please sign in to comment.