diff --git a/docs.json b/docs.json index 028104d6..079060fc 100644 --- a/docs.json +++ b/docs.json @@ -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", diff --git a/integrations/integration-guides/linear.mdx b/integrations/integration-guides/linear.mdx new file mode 100644 index 00000000..05a14801 --- /dev/null +++ b/integrations/integration-guides/linear.mdx @@ -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' + + + +The official Linear integration lets your bot automate issue workflows and react to repository file events. + +{/* vale on */} + +## Setup + + + + + 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 + + + + + In Botpress Studio, select **Explore Hub** in the upper-right corner. + + + Search for the **Linear** integration, then select **Install Integration**. + + + In the **Configuration** menu, select **Authorize Linear**. + + + Follow the on-screen instructions to connect Botpress to your Linear workspace. + + + + + 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. + + + + + + For advanced use cases, you can configure the integration with a Linear **API key** and **Webhook Signing Secret** instead of OAuth. + + + 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 + + + ### Creating a Linear API key + + + + On Linear, navigate to your account settings and select the **API** tab in the navigation sidebar. + + + Under **Personal API keys**, enter a name for your API key and select **Create new API key**. + + + Save this API key in a secure location. You will need it to configure the Linear integration in Botpress. + + + Treat API keys like passwords. Store them securely and rotate them if they’re exposed. + + + + + ### Subscribing to Linear webhook events + + + + In Botpress, open the **Configuration** page for the Linear integration. + + + Copy the **Webhook URL** generated by Botpress. + + + On Linear, go to your account settings and select the **API** tab in the navigation sidebar. + + + Under **Webhooks**, select **Create new webhook**. + + + Enter a name for the webhook and paste the webhook URL from Botpress into the **URL** field. + + + Copy the **webhook signing secret** and store it in a secure location. You will need it to configure the Linear integration in Botpress. + + + 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. + + + Under **Teams**, select the teams you want to receive notifications for. + + + Select **Create webhook** to save your changes. + + + + ### Configuring the Linear integration in Botpress + + + + In Botpress, open the **Configuration** page for the Linear integration. + + + Select **Configure Linear with an API Key**. + + + Enter the API key from Linear in the **API Key** field. + + + Enter the webhook signing secret from Linear in the **Webhook Signing Secret** field. + + + Save the configuration and enable the integration. + + + + + Your Linear integration is ready. Use the **Cards** and **Triggers** sections below to build your workflows. + + + + + +--- + +## Cards + + + +--- + +## Triggers + + diff --git a/snippets/integrations/versions.mdx b/snippets/integrations/versions.mdx index a3103020..bb5cd7c1 100644 --- a/snippets/integrations/versions.mdx +++ b/snippets/integrations/versions.mdx @@ -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",