Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,7 @@
"integrations/integration-guides/klaviyo",
"/integrations/integration-guides/knowledge-base-optimization",
"/integrations/integration-guides/line",
"/integrations/integration-guides/linear",
"/integrations/integration-guides/linkedin",
"/integrations/integration-guides/loops",
"/integrations/integration-guides/mailerlite",
Expand Down
154 changes: 154 additions & 0 deletions integrations/integration-guides/linear.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
---
title: Linear
description: Connect your bot to Linear using the official integration.
icon: 'https://cdn.simpleicons.org/linear/5E6AD2'
---

{/* vale off */}

import integrationVersions from '/snippets/integrations/versions.mdx'
import { OpenInHub } from '/snippets/integrations/open-in-hub.jsx'
import Cards from '/snippets/integrations/cards/botpress/linear.mdx'
import Triggers from '/snippets/integrations/triggers/botpress/linear.mdx'

<OpenInHub integration={integrationVersions.linear}/>

The official Linear integration lets your bot automate issue workflows and react to repository file events.

{/* vale on */}

## Setup

<Tabs>
<Tab title="Basic configuration">
<Info>
You will need:

- A [published bot](/get-started/quick-start)
- A [Linear](https://linear.app) account with access to the workspace you want to connect
</Info>

<Steps>
<Step>
In Botpress Studio, select **Explore Hub** in the upper-right corner.
</Step>
<Step>
Search for the **Linear** integration, then select **Install Integration**.
</Step>
<Step>
In the **Configuration** menu, select **Authorize Linear**.
</Step>
<Step>
Follow the on-screen instructions to connect Botpress to your Linear workspace.
</Step>
</Steps>

<Note>
When using this configuration mode, Botpress connects to Linear using OAuth. Actions taken by the bot use the Linear account that completed authorization.

If you need an API key, webhook signing secret, or more control over how Linear sends events to Botpress, use [Manual configuration](#manual-configuration) instead.
</Note>

</Tab>
<Tab title="Manual configuration">

For advanced use cases, you can configure the integration with a Linear **API key** and **Webhook Signing Secret** instead of OAuth.

<Info>
You will need:

- A [published bot](/get-started/quick-start)
- A [Linear](https://linear.app) account with access to the workspace you want to connect
</Info>

### Creating a Linear API key

<Steps>
<Step>
On Linear, navigate to your account settings and select the **API** tab in the navigation sidebar.
</Step>
<Step>
Under **Personal API keys**, enter a name for your API key and select **Create new API key**.
</Step>
<Step>
Save this API key in a secure location. You will need it to configure the Linear integration in Botpress.

<Note>
Treat API keys like passwords. Store them securely and rotate them if they’re exposed.
</Note>
</Step>
</Steps>

### Subscribing to Linear webhook events

<Steps>
<Step>
In Botpress, open the **Configuration** page for the Linear integration.
</Step>
<Step>
Copy the **Webhook URL** generated by Botpress.
</Step>
<Step>
On Linear, go to your account settings and select the **API** tab in the navigation sidebar.
</Step>
<Step>
Under **Webhooks**, select **Create new webhook**.
</Step>
<Step>
Enter a name for the webhook and paste the webhook URL from Botpress into the **URL** field.
</Step>
<Step>
Copy the **webhook signing secret** and store it in a secure location. You will need it to configure the Linear integration in Botpress.
</Step>
<Step>
Under **Data change events**, choose the events to subscribe to:

- **Issues**: Receive notifications when issues are created, updated, or deleted.
- **Comments**: Receive notifications when comments are added to issues.
</Step>
<Step>
Under **Teams**, select the teams you want to receive notifications for.
</Step>
<Step>
Select **Create webhook** to save your changes.
</Step>
</Steps>

### Configuring the Linear integration in Botpress

<Steps>
<Step>
In Botpress, open the **Configuration** page for the Linear integration.
</Step>
<Step>
Select **Configure Linear with an API Key**.
</Step>
<Step>
Enter the API key from Linear in the **API Key** field.
</Step>
<Step>
Enter the webhook signing secret from Linear in the **Webhook Signing Secret** field.
</Step>
<Step>
Save the configuration and enable the integration.
</Step>
</Steps>

<Check>
Your Linear integration is ready. Use the **Cards** and **Triggers** sections below to build your workflows.
</Check>

</Tab>
</Tabs>

---

## Cards

<Cards />

---

## Triggers

<Triggers />
4 changes: 2 additions & 2 deletions snippets/integrations/versions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -360,8 +360,8 @@ export const integrationVersions = {
"id": "intver_01KJG7STTTV9MVG9XMCJCEBMPK"
},
"linear": {
"version": "2.1.0",
"id": "intver_01KMK8X8R3331ZWHJRXMD47D7P"
"version": "2.1.1",
"id": "intver_01KMZAMYYMP9V486JY1M8E90AB"
},
"linkedin": {
"version": "0.1.1",
Expand Down
Loading