Skip to main content
instantly-observability Set up monitoring, alerting, and dashboards for Instantly.ai integrations.
Use when implementing campaign health monitoring, account health alerts,
or building analytics dashboards from Instantly data.
Trigger with phrases like "instantly monitoring", "instantly dashboard",
"instantly alerts", "instantly observability", "monitor instantly campaigns".
Zur Installation springen Skills Marktplatz Entdecken und erkunden Sie KI-Skills, die von der Community erstellt wurden.
Mit Codex oder Claude installieren Kopieren Sie diesen Prompt, fügen Sie ihn in Codex, Claude oder einen anderen Assistant ein und lassen Sie die Skill-Seite prüfen und installieren.
Prompt-Details anzeigen Ein direkter Befehl überspringt den Prüf-Prompt. Prüfen Sie die Quelle, bevor Sie ihn ausführen.
npx skills add https://github.com/jeremylongshore/claude-code-plugins-plus-skills --skill instantly-observabilityDer Befehl bleibt in einer Zeile. Scrollen Sie horizontal, um ihn vor dem Kopieren vollständig zu prüfen.
Sie bevorzugen eine lokale Kopie? Laden Sie die Dateien herunter, die SkillsMP derzeit vorliegen.
ZIP herunterladen Herunterladen... Mehr aus diesem Repository
Verwandte Berufe SOC
Basierend auf der SOC-Berufsklassifikation
name instantly-observability description Set up monitoring, alerting, and dashboards for Instantly.ai integrations.
Use when implementing campaign health monitoring, account health alerts,
or building analytics dashboards from Instantly data.
Trigger with phrases like "instantly monitoring", "instantly dashboard",
"instantly alerts", "instantly observability", "monitor instantly campaigns".
allowed-tools Read, Write, Edit, Bash(npm:*), Bash(curl:*), Grep version 1.12.0 license MIT author Jeremy Longshore <jeremy@intentsolutions.io> tags ["saas","instantly","observability","monitoring","alerting"] compatibility Designed for Claude Code, also compatible with Codex and OpenClaw
Instantly Observability
Overview
Build monitoring and alerting for Instantly integrations. Covers campaign health checks, account warmup monitoring, webhook delivery tracking, deliverability alerts, and performance dashboards. Uses Instantly API v2 analytics endpoints combined with webhook events for real-time awareness.
Prerequisites
Completed instantly-install-auth setup
API key with campaigns:read, accounts:read, and all:read scopes
Notification channel (Slack, email, PagerDuty, etc.)
Instructions
Step 1: Campaign Health Monitor
import { InstantlyClient } from "./src/instantly/client" ;
const client = new InstantlyClient ();
interface HealthCheck {
check : string ;
status : "ok" | "warning" | "critical" ;
message : string ;
}
async function campaignHealthCheck (Promise <HealthCheck []> {
const checks : HealthCheck [] = [];
const campaigns = await client.campaigns .list (100 );
for (const campaign of campaigns.filter ((c ) => c.status === 1
const
await
campaigns
analytics
id
const
emails_sent
1
const
emails_bounced
100
if
5
push
check
`bounce_rate:${campaign.name} `
status
"critical"
message
`Bounce rate ${bounceRate.toFixed(1 )} % exceeds 5% threshold. Campaign may be auto-paused.`
else
if
3
push
check
`bounce_rate:${campaign.name} `
status
"warning"
message
`Bounce rate ${bounceRate.toFixed(1 )} % approaching 5% threshold.`
const
emails_replied
100
if
1
100
push
check
`reply_rate:${campaign.name} `
status
"warning"
message
`Reply rate ${replyRate.toFixed(1 )} % is below 1% after ${sent} sends. Review email copy.`
const
emails_opened
100
if
20
100
push
check
`open_rate:${campaign.name} `
status
"warning"
message
`Open rate ${openRate.toFixed(1 )} % below 20%. Check subject lines and deliverability.`
const
filter
(c ) =>
status
1
const
filter
(c ) =>
status
2
if
length
0
push
check
"unhealthy_campaigns"
status
"critical"
message
`${unhealthy.length} campaign(s) in Accounts Unhealthy state: ${unhealthy.map((c) => c.name).join(", " )} `
if
length
0
push
check
"bounce_protected_campaigns"
status
"critical"
message
`${bounceProtected.length} campaign(s) paused by Bounce Protect: ${bounceProtected.map((c) => c.name).join(", " )} `
return
Step 2: Account Warmup Monitor async function warmupHealthCheck (Promise <HealthCheck []> {
const checks : HealthCheck [] = [];
const accounts = await client.accounts .list (100 );
const emails = accounts.map ((a ) => a.email );
if (emails.length === 0 ) return checks;
const warmup = await client.accounts .warmupAnalytics (emails);
for (const w of warmup as Array <{
email : string ;
warmup_emails_sent : number ;
warmup_emails_landed_inbox : number ;
warmup_emails_landed_spam : number ;
}>) {
const sent = w.warmup_emails_sent || 1 ;
const inboxRate = (w.warmup_emails_landed_inbox / sent) * 100 ;
const spamRate = (w.warmup_emails_landed_spam / sent) * 100 ;
if (inboxRate < 80 ) {
checks.push ({
check : `warmup_inbox_rate:${w.email} ` ,
status : inboxRate < 60 ? "critical" : "warning" ,
message : `${w.email} warmup inbox rate ${inboxRate.toFixed(1 )} % (${inboxRate < 60 ? "critical" : "below 80%" } )` ,
});
}
if (spamRate > 10 ) {
checks.push ({
check : `warmup_spam_rate:${w.email} ` ,
status : "critical" ,
message : `${w.email} warmup spam rate ${spamRate.toFixed(1 )} % — reputation issue` ,
});
}
}
const vitals = await client.accounts .testVitals (emails) as Array <{
email : string ; smtp_status : string ; imap_status : string ;
}>;
const broken = vitals.filter ((v ) => v.smtp_status !== "ok" || v.imap_status !== "ok" );
if (broken.length > 0 ) {
checks.push ({
check : "account_vitals" ,
status : "critical" ,
message : `${broken.length} account(s) with broken SMTP/IMAP: ${broken.map((v) => v.email).join(", " )} ` ,
});
}
return checks;
}
Step 3: Webhook Delivery Monitor async function webhookHealthCheck (Promise <HealthCheck []> {
const checks : HealthCheck [] = [];
const summary = await client.request <{
total_delivered : number ;
total_failed : number ;
total_pending : number ;
}>("/webhook-events/summary" );
if (summary.total_failed > 0 ) {
const failRate = (summary.total_failed / (summary.total_delivered + summary.total_failed )) * 100 ;
checks.push ({
check : "webhook_delivery" ,
status : failRate > 10 ? "critical" : "warning" ,
message : `Webhook delivery: ${summary.total_delivered} delivered, ${summary.total_failed} failed (${failRate.toFixed(1 )} % fail rate)` ,
});
}
const webhooks = await client.webhooks .list ();
const paused = webhooks.filter ((w : any w.status === "paused" );
if (paused.length > 0 ) {
checks.push ({
check : "webhooks_paused" ,
status : "critical" ,
message : `${paused.length} webhook(s) are paused — events are being dropped` ,
});
}
return checks;
}
Step 4: Alerting Pipeline async function runHealthChecks (console .log (`\n=== Instantly Health Check — ${new Date ().toISOString()} ===\n` );
const allChecks : HealthCheck [] = [
...await campaignHealthCheck (),
...await warmupHealthCheck (),
...await webhookHealthCheck (),
];
for (const check of allChecks) {
const icon = check.status === "ok" ? "OK" : check.status === "warning" ? "WARN" : "CRIT" ;
console .log (`[${icon} ] ${check.check} : ${check.message} ` );
}
const critical = allChecks.filter ((c ) => c.status === "critical" );
const warnings = allChecks.filter ((c ) => c.status === "warning" );
if (critical.length > 0 ) {
await sendAlert ("critical" , critical);
}
if (warnings.length > 0 ) {
await sendAlert ("warning" , warnings);
}
console .log (`\nSummary: ${critical.length} critical, ${warnings.length} warnings, ${allChecks.length} total checks` );
}
async function sendAlert (severity : string , checks : HealthCheck []const color = severity === "critical" ? "#FF0000" : "#FFA500" ;
const text = checks.map ((c ) => `*${c.check} *: ${c.message} ` ).join ("\n" );
await fetch (process.env .SLACK_WEBHOOK_URL !, {
method : "POST" ,
headers : { "Content-Type" : "application/json" },
body : JSON .stringify ({
attachments : [{
color,
title : `Instantly ${severity.toUpperCase()} Alert` ,
text,
ts : Math .floor (Date .now () / 1000 ),
}],
}),
});
}
Step 5: Scheduled Monitoring (Cron)
import cron from "node-cron" ;
cron.schedule ("*/15 * * * *" , async () => {
try {
await runHealthChecks ();
} catch (err) {
console .error ("Health check failed:" , err);
await sendAlert ("critical" , [{ check : "monitor" , status : "critical" , message : `Monitor itself failed: ${err} ` }]);
}
});
Dashboard Metrics Summary Metric Source Alert Threshold Campaign bounce rate GET /campaigns/analytics>5% critical Campaign reply rate GET /campaigns/analytics<1% warning Campaign open rate GET /campaigns/analytics<20% warning Warmup inbox rate POST /accounts/warmup-analytics<80% warning, <60% critical Account vitals POST /accounts/test/vitalsAny non-ok = critical Webhook delivery GET /webhook-events/summary>10% fail rate = critical Unhealthy campaigns GET /campaignsstatus=-1 = critical Bounce protected campaigns GET /campaignsstatus=-2 = critical
Error Handling Error Cause Solution Monitor itself rate-limited Too-frequent checks Increase interval to 15-30 min Slack alert not delivered Invalid webhook URL Verify SLACK_WEBHOOK_URL Stale analytics data Instantly updates delay Allow 1-hour data lag
Resources
Instantly Analytics API
Instantly Account API
Instantly Webhook Events
Next Steps For incident response, see instantly-incident-runbook.
