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 shows how to connect Xquik to Corsair with API key authentication.

​
Authentication Method

The Xquik plugin uses API key authentication.
  • api_key (default) - sends the key as the x-api-key header

​
API Key Setup

​
Step 1: Create an API Key

  1. Sign in to the Xquik dashboard.
  2. Open the API keys area.
  3. Create a key for your Corsair integration.
  4. Copy the key and store it securely.

​
Step 2: Store the Key in Corsair

Use the Corsair CLI: 
pnpm corsair setup --plugin=xquik api_key=your-xquik-api-key
Or pass the key directly in code:
corsair.ts
xquik({
	key: process.env.XQUIK_API_KEY,
})

​
Webhook Secret

When you create an Xquik webhook endpoint, Xquik returns the HMAC signing secret once in the create response. Store that value in Corsair so incoming deliveries can be verified. 
pnpm corsair setup --plugin=xquik webhook_signature=your-xquik-webhook-secret
Or pass it directly in code:
corsair.ts
xquik({
	webhookSecret: process.env.XQUIK_WEBHOOK_SECRET,
})
Xquik webhook deliveries include X-Xquik-Signature, X-Xquik-Timestamp, and X-Xquik-Nonce headers. The plugin verifies the signature over the raw request body before handling monitor events.

​
Required Credentials Summary

CredentialRequired ForWhere to Find
API KeyAPI callsXquik dashboard API keys
Webhook SecretIncoming webhooksReturned when creating an Xquik webhook endpoint
For the public REST API surface, see the Xquik API overview.