instantly-security-basics
Apply Instantly security best practices for secrets and access control.Use when securing API keys, implementing least privilege access,or auditing Instantly security configuration.Trigger with phrases like "instantly security", "instantly secrets","secure instantly", "instantly API key security".
When & Why to Use This Skill
This Claude skill provides a comprehensive framework for implementing security best practices within the Instantly ecosystem. It focuses on robust API key management, automated secret rotation, and the enforcement of least privilege access. By integrating these security protocols, developers can safeguard their credentials, verify webhook authenticity, and maintain detailed audit logs to ensure compliance and prevent unauthorized data access.
Use Cases
- Securing API keys and sensitive credentials using environment variables and .gitignore configurations to prevent accidental exposure in public repositories.
- Implementing automated secret rotation workflows to minimize the window of vulnerability in the event of a credential leak.
- Applying the principle of least privilege by defining environment-specific scopes (read/write) for development, staging, and production environments.
- Validating incoming webhook signatures using HMAC SHA-256 to ensure data integrity and authenticity from the Instantly platform.
- Establishing a centralized audit logging system to track API interactions and user actions for security monitoring and regulatory compliance.
| name | instantly-security-basics |
|---|---|
| description | | |
| allowed-tools | Read, Write, Grep |
| version | 1.0.0 |
| license | MIT |
| author | Jeremy Longshore <jeremy@intentsolutions.io> |
Instantly Security Basics
Overview
Security best practices for Instantly API keys, tokens, and access control.
Prerequisites
- Instantly SDK installed
- Understanding of environment variables
- Access to Instantly dashboard
Instructions
Step 1: Configure Environment Variables
# .env (NEVER commit to git)
INSTANTLY_API_KEY=sk_live_***
INSTANTLY_SECRET=***
# .gitignore
.env
.env.local
.env.*.local
Step 2: Implement Secret Rotation
# 1. Generate new key in Instantly dashboard
# 2. Update environment variable
export INSTANTLY_API_KEY="new_key_here"
# 3. Verify new key works
curl -H "Authorization: Bearer ${INSTANTLY_API_KEY}" \
https://api.instantly.com/health
# 4. Revoke old key in dashboard
Step 3: Apply Least Privilege
| Environment | Recommended Scopes |
|---|---|
| Development | read:* |
| Staging | read:*, write:limited |
| Production | Only required scopes |
Output
- Secure API key storage
- Environment-specific access controls
- Audit logging enabled
Error Handling
| Security Issue | Detection | Mitigation |
|---|---|---|
| Exposed API key | Git scanning | Rotate immediately |
| Excessive scopes | Audit logs | Reduce permissions |
| Missing rotation | Key age check | Schedule rotation |
Examples
Service Account Pattern
const clients = {
reader: new InstantlyClient({
apiKey: process.env.INSTANTLY_READ_KEY,
}),
writer: new InstantlyClient({
apiKey: process.env.INSTANTLY_WRITE_KEY,
}),
};
Webhook Signature Verification
import crypto from 'crypto';
function verifyWebhookSignature(
payload: string, signature: string, secret: string
): boolean {
const expected = crypto.createHmac('sha256', secret).update(payload).digest('hex');
return crypto.timingSafeEqual(Buffer.from(signature), Buffer.from(expected));
}
Security Checklist
- API keys in environment variables
-
.envfiles in.gitignore - Different keys for dev/staging/prod
- Minimal scopes per environment
- Webhook signatures validated
- Audit logging enabled
Audit Logging
interface AuditEntry {
timestamp: Date;
action: string;
userId: string;
resource: string;
result: 'success' | 'failure';
metadata?: Record<string, any>;
}
async function auditLog(entry: Omit<AuditEntry, 'timestamp'>): Promise<void> {
const log: AuditEntry = { ...entry, timestamp: new Date() };
// Log to Instantly analytics
await instantlyClient.track('audit', log);
// Also log locally for compliance
console.log('[AUDIT]', JSON.stringify(log));
}
// Usage
await auditLog({
action: 'instantly.api.call',
userId: currentUser.id,
resource: '/v1/resource',
result: 'success',
});
Resources
Next Steps
For production deployment, see instantly-prod-checklist.