Skip to main content
This guide walks you through obtaining all required credentials for the Sentry plugin.

Authentication Method

The Sentry plugin uses API key authentication.
  • api_key (default) — Sentry User auth token (sent as Authorization: Bearer <token> to https://sentry.io/api/0/)
Sentry’s API expects a bearer token with sufficient scopes for the endpoints you use (organizations, projects, issues, releases, etc.).

User Auth Token

Step 1: Create a Token

  1. Log in to Sentry.
  2. Open SettingsAccountAuth Tokens (or User settingsAuth Tokens).
  3. Click Create New Token.
  4. Name the token (for example, Corsair) and select scopes that match your needs — at minimum, the read/write scopes for organizations, projects, issues, or releases you will access via Corsair.
  5. Create the token and copy it immediately.
Storing credentials:
pnpm corsair setup --plugin=sentry api_key=your-auth-token
Verify:
pnpm corsair auth --plugin=sentry --credentials
If you self-host Sentry, generate tokens from your instance’s account settings the same way; Corsair still sends the value as a Bearer token to your configured API base where applicable.

Webhook Secret

Sentry integrations that deliver webhooks to your app may include a secret for verifying sentry-hook-signature (or related headers).
  1. In Sentry, open SettingsIntegrations (or your Internal integration) for the project or organization.
  2. Configure the outbound webhook and copy the secret used for signature verification.
Storing credentials:
pnpm corsair setup --plugin=sentry webhook_signature=your-webhook-secret

Required Credentials Summary

CredentialRequired forWhere to find
User auth tokenapi_key authSentry → Settings → Auth Tokens
Webhook secretWebhooksIntegration / webhook configuration
For general information about how Corsair handles authentication, see Authentication.