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

​
Authentication Method

The Amplitude plugin uses API key authentication.
  • api_key (default) — Credentials for Amplitude’s HTTP APIs (Dashboard API uses Basic auth)
Corsair stores a single api_key string. For endpoints that call the Dashboard API, Amplitude expects HTTP Basic auth built from your API key and secret key joined with a colon.

​
Step 1: Get API Key and Secret Key

  1. Log in to Amplitude.
  2. Open Settings → Projects and select your project (or use Organization settings as appropriate).
  3. Open the API Keys section for that project.
  4. Copy the API Key and Secret Key (sometimes labeled Secret).

​
Step 2: Store as One Credential

Combine them exactly as API_KEY:SECRET_KEY (a single colon between the two values, no spaces). This matches how Amplitude’s Dashboard API expects Basic authentication to be constructed. Storing credentials: 
pnpm corsair setup --plugin=amplitude api_key='YOUR_API_KEY:YOUR_SECRET_KEY'
Verify: 
pnpm corsair auth --plugin=amplitude --credentials
Some Amplitude HTTP APIs pass an api_key field in JSON bodies for event payloads; those flows may use the project API key alone. Refer to the operation you are calling and Amplitude’s docs for that API if you need only the public API key.

​
Webhook Secret

Amplitude can send signed webhooks to your app. Configure the webhook in the Amplitude product UI and copy the secret used to verify the X-Amplitude-Signature (or equivalent) header for your destination. Storing credentials: 
pnpm corsair setup --plugin=amplitude webhook_signature=your-webhook-secret

​
Required Credentials Summary

CredentialRequired forWhere to find
API_KEY:SECRET_KEY stringapi_key (Dashboard API / Basic)Project → API Keys
Webhook secretWebhook verificationAmplitude webhook destination settings
For general information about how Corsair handles authentication, see Authentication.