| name | instantly-webhooks-events |
| description | Implement Instantly webhook signature validation and event handling.
Use when setting up webhook endpoints, implementing signature verification,
or handling Instantly event notifications securely.
Trigger with phrases like "instantly webhook", "instantly events",
"instantly webhook signature", "handle instantly events", "instantly notifications".
|
| allowed-tools | Read, Write, Edit, Bash(curl:*) |
| version | 1.0.0 |
| license | MIT |
| author | Jeremy Longshore <jeremy@intentsolutions.io> |
Instantly Webhooks & Events
Overview
Securely handle Instantly webhooks with signature validation and replay protection.
Prerequisites
- Instantly webhook secret configured
- HTTPS endpoint accessible from internet
- Understanding of cryptographic signatures
- Redis or database for idempotency (optional)
Webhook Endpoint Setup
Express.js
import express from 'express';
import crypto from 'crypto';
const app = express();
app.post('/webhooks/instantly',
express.raw({ type: 'application/json' }),
async (req, res) => {
const signature = req.headers['x-instantly-signature'] as string;
const timestamp = req.headers['x-instantly-timestamp'] as string;
if (!verifyInstantlySignature(req.body, signature, timestamp)) {
return res.status(401).json({ error: 'Invalid signature' });
}
const event = JSON.parse(req.body.toString());
await handleInstantlyEvent(event);
res.status(200).json({ received: true });
}
);
Signature Verification
function verifyInstantlySignature(
payload: Buffer,
signature: string,
timestamp: string
): boolean {
const secret = process.env.INSTANTLY_WEBHOOK_SECRET!;
const timestampAge = Date.now() - parseInt(timestamp) * 1000;
if (timestampAge > 300000) {
console.error('Webhook timestamp too old');
return false;
}
const signedPayload = `${timestamp}.${payload.toString()}`;
const expectedSignature = crypto
.createHmac('sha256', secret)
.update(signedPayload)
.digest('hex');
return crypto.timingSafeEqual(
Buffer.from(signature),
Buffer.from(expectedSignature)
);
}
Event Handler Pattern
type InstantlyEventType = 'resource.created' | 'resource.updated' | 'resource.deleted';
interface InstantlyEvent {
id: string;
type: InstantlyEventType;
data: Record<string, any>;
created: string;
}
const eventHandlers: Record<InstantlyEventType, (data: any) => Promise<void>> = {
'resource.created': async (data) => { },
'resource.updated': async (data) => { },
'resource.deleted': async (data) => { }
};
async function handleInstantlyEvent(event: InstantlyEvent): Promise<void> {
const handler = eventHandlers[event.type];
if (!handler) {
console.log(`Unhandled event type: ${event.}`);
;
}
{
(event.);
.();
} (error) {
.(, error);
error;
}
}
Idempotency Handling
import { Redis } from 'ioredis';
const redis = new Redis(process.env.REDIS_URL);
async function isEventProcessed(eventId: string): Promise<boolean> {
const key = `instantly:event:${eventId}`;
const exists = await redis.exists(key);
return exists === 1;
}
async function markEventProcessed(eventId: string): Promise<void> {
const key = `instantly:event:${eventId}`;
await redis.set(key, '1', 'EX', 86400 * 7);
}
Webhook Testing
instantly webhooks trigger resource.created --url http://localhost:3000/webhooks/instantly
curl -X POST https://webhook.site/your-uuid \
-H "Content-Type: application/json" \
-d '{"type": "resource.created", "data": {}}'
Instructions
Step 1: Register Webhook Endpoint
Configure your webhook URL in the Instantly dashboard.
Step 2: Implement Signature Verification
Use the signature verification code to validate incoming webhooks.
Step 3: Handle Events
Implement handlers for each event type your application needs.
Step 4: Add Idempotency
Prevent duplicate processing with event ID tracking.
Output
- Secure webhook endpoint
- Signature validation enabled
- Event handlers implemented
- Replay attack protection active
Error Handling
| Issue | Cause | Solution |
|---|
| Invalid signature | Wrong secret | Verify webhook secret |
| Timestamp rejected | Clock drift | Check server time sync |
| Duplicate events | Missing idempotency | Implement event ID tracking |
| Handler timeout | Slow processing | Use async queue |
Examples
Testing Webhooks Locally
ngrok http 3000
curl -X POST https://your-ngrok-url/webhooks/instantly \
-H "Content-Type: application/json" \
-d '{"type": "test", "data": {}}'
Resources
Next Steps
For performance optimization, see instantly-performance-tuning.