sourcegraph/dev/linearhooks/README.md
2024-05-07 00:14:05 -07:00

1.4 KiB

Linear Webhooks

Development

Caution

DO NOT commit your api key

First make a copy of the dotenv file and set the API key and webhook signing secrets in .env based on the Linear API settings. If you don't have access, reach out to #wg-linear-trial.

cp .env.example .env
source .env
go run .

Use ngrok to get a public URL for receiving webhook events:

ngrok http 3000

Set the webhook URL in Linear.

Deployment

This service is deployed as a MSP service. Learn more from go/msp.

Caution

Keep your secret safe

In production, it's recommended to create a Linear OAuth2 application, and create a developer token using application identity as actor. Then, set the developer token as LINEAR_PERSONAL_API_KEY in the deployment. Othewise, your personal identity will be associated with all requests.

Unfortunately, Linear only supports authorization_code grant type, but not client_credentials. Authenticating through the web interface (e.g., OAuth callback) is a lot of added complexity for a simply webhook service. We will revisit in the future.

Configuration

Refer to config.example.yaml