Get Credentials

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

Authentication Method

The Vapi plugin uses API key authentication.

api_key (default) - API key authentication

API Key Setup

Step 1: Get API Key

Log in to your Vapi dashboard
Click on your account name in the top-right corner
Go to Organization → API Keys
Click Create API Key
Give your key a name (e.g., “Corsair Integration”)
Copy the API key immediately
Important: Store the key securely — you won’t be able to see it again

Storing Credentials: The preferred method is to store the API key in the database using the keys API:

await corsair
    .withTenant('default')
    .vapi.keys.setApiKey('your-api-key');

Alternatively, you can provide the key directly in the plugin configuration:

corsair.ts

vapi({
    key: process.env.VAPI_API_KEY,
})

Or store it with the Corsair CLI:

pnpm corsair setup --plugin=vapi api_key=your-api-key

Webhook Secret

Vapi uses a shared secret header (x-vapi-secret) rather than an HMAC signature. You choose the secret value and configure it in both your Vapi server URL settings and Corsair.

Step 1: Configure Webhook URL in Vapi

In the Vapi dashboard, go to Settings → Webhooks (or configure per-assistant via serverUrl)
Set the Server URL to your webhook endpoint (e.g., https://yourapp.com/api/webhook)
Set the Server URL Secret to a strong random string — this is the shared secret Vapi will send as the x-vapi-secret header on every request

Step 2: Store the Secret in Corsair

Preferred method — store in the database:

await corsair
    .withTenant('default')
    .vapi.keys.setWebhookSignature('your-webhook-secret');

Or pass it directly in the plugin configuration:

corsair.ts

vapi({
    webhookSecret: process.env.VAPI_WEBHOOK_SECRET,
})

Or use the CLI:

pnpm corsair setup --plugin=vapi webhook_signature=your-webhook-secret

Required Credentials Summary

Credential	Required For	Where to Find
API Key	API calls	Dashboard → Organization → API Keys
Webhook Secret	Incoming webhooks	Your own value — set in Vapi’s Server URL Secret field

For general information about how Corsair handles authentication, see Authentication.

Overview

Plugins

Get Credentials

Authentication Method

API Key Setup

Step 1: Get API Key

Webhook Secret

Step 1: Configure Webhook URL in Vapi

Step 2: Store the Secret in Corsair

Required Credentials Summary

​Authentication Method

​API Key Setup

​Step 1: Get API Key

​Webhook Secret

​Step 1: Configure Webhook URL in Vapi

​Step 2: Store the Secret in Corsair

​Required Credentials Summary

Authentication Method

API Key Setup

Step 1: Get API Key

Webhook Secret

Step 1: Configure Webhook URL in Vapi

Step 2: Store the Secret in Corsair

Required Credentials Summary