instantly-hello-world
Create a minimal working Instantly example.Use when starting a new Instantly integration, testing your setup,or learning basic Instantly API patterns.Trigger with phrases like "instantly hello world", "instantly example","instantly quick start", "simple instantly code".
When & Why to Use This Skill
The Instantly Hello World skill is a developer-focused utility designed to accelerate the initial integration of the Instantly API. It provides a minimal, production-ready boilerplate for initializing the Instantly SDK in both TypeScript and Python. By automating the creation of entry files and client configuration, it ensures developers can verify their API credentials and network connectivity instantly, reducing the friction of starting new outreach automation projects.
Use Cases
- Quickly bootstrapping a new Instantly integration by generating the necessary boilerplate code for client initialization.
- Testing and verifying API credentials (API keys) and environment variables to ensure a successful connection to Instantly servers.
- Learning the fundamental API patterns and SDK syntax for Instantly through a simplified 'Hello World' implementation.
- Troubleshooting integration issues by isolating the core connection logic from complex application code.
- Setting up a standardized development environment for cold outreach automation and lead management tools.
| name | instantly-hello-world |
|---|---|
| description | | |
| allowed-tools | Read, Write, Edit |
| version | 1.0.0 |
| license | MIT |
| author | Jeremy Longshore <jeremy@intentsolutions.io> |
Instantly Hello World
Overview
Minimal working example demonstrating core Instantly functionality.
Prerequisites
- Completed
instantly-install-authsetup - Valid API credentials configured
- Development environment ready
Instructions
Step 1: Create Entry File
Create a new file for your hello world example.
Step 2: Import and Initialize Client
import { InstantlyClient } from '@instantly/sdk';
const client = new InstantlyClient({
apiKey: process.env.INSTANTLY_API_KEY,
});
Step 3: Make Your First API Call
async function main() {
// Your first API call here
}
main().catch(console.error);
Output
- Working code file with Instantly client initialization
- Successful API response confirming connection
- Console output showing:
Success! Your Instantly connection is working.
Error Handling
| Error | Cause | Solution |
|---|---|---|
| Import Error | SDK not installed | Verify with npm list or pip show |
| Auth Error | Invalid credentials | Check environment variable is set |
| Timeout | Network issues | Increase timeout or check connectivity |
| Rate Limit | Too many requests | Wait and retry with exponential backoff |
Examples
TypeScript Example
import { InstantlyClient } from '@instantly/sdk';
const client = new InstantlyClient({
apiKey: process.env.INSTANTLY_API_KEY,
});
async function main() {
// Your first API call here
}
main().catch(console.error);
Python Example
from instantly import InstantlyClient
client = InstantlyClient()
# Your first API call here
Resources
Next Steps
Proceed to instantly-local-dev-loop for development workflow setup.