Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you through obtaining all required credentials for the Linear plugin.

​
Authentication Method

The Linear plugin uses API key authentication.
  • api_key (default) - Personal API key authentication

​
API Key Setup

​
Step 1: Generate API Key

  1. Go to Linear Settings → API
  2. Navigate to the API section
  3. Under Personal API keys, click Create API key
  4. Give your key a name (e.g., “Corsair Integration”)
  5. Copy the API key immediately
  6. Important: Store the key securely - you won’t be able to see it again
Storing Credentials: Store the API key with the Corsair CLI: 
pnpm corsair setup --plugin=linear api_key=your-api-key
Verify it was saved: 
pnpm corsair auth --plugin=linear --credentials

​
Webhook Secret

​
Step 1: Create Webhook

  1. Go to Linear Settings → API
  2. Navigate to Webhooks section
  3. Click Create Webhook
  4. Configure:
    • Label: Your webhook name
    • URL: Your webhook endpoint (e.g., https://yourapp.com/api/webhook)
    • Resource types: Select:
      • Issues
      • Comments
      • Projects
  5. Click Create Webhook
  6. After creation, copy the Signing Secret shown
  7. Store it securely
Storing Credentials: Store the webhook secret with the CLI: 
pnpm corsair setup --plugin=linear webhook_signature=your-webhook-secret

​
Required Credentials Summary

CredentialRequired ForWhere to Find
API KeyAPI Key authSettings → API → Personal API keys
Webhook SecretWebhooksSettings → API → Webhooks → Signing Secret
For general information about how Corsair handles authentication, see Authentication.