@beckett-alkali/n8n-nodes-outreachio
v0.1.2
Published
n8n community node to work with the Outreach.io API - Send emails, manage prospects, sequences, and sequence states
Maintainers
Readme
n8n-nodes-outreachio
n8n community node for Outreach.io integration. Manage prospects, send emails, work with sequences, and automate your sales processes.
Features
Outreach Node
- Prospect Management: Create, update, and manage prospects
- Email Campaigns: Send individual emails and manage mailing sequences
- Sequence Management: Automate prospect sequences and follow-ups
- Load Options: Dynamic loading of prospects, mailboxes, and templates
OAuth2 Credential Support
- Secure OAuth2 authentication with Outreach.io
- Automatic token refresh
- Scoped permissions
Installation
In n8n (Recommended)
- Go to Settings > Community Nodes
- Enter
@alkali-partners/n8n-nodes-outreachio - Click Install
- Restart n8n
Via npm
npm install @alkali-partners/n8n-nodes-outreachioThen restart your n8n instance.
Setup
1. Create Outreach.io OAuth Application
- Go to Outreach Developer Portal
- Create a new application
- Note your
Client IDandClient Secret - Set redirect URI to:
{your-n8n-url}/rest/oauth2-credential/callback
2. Configure Credentials in n8n
- In n8n, go to Credentials
- Create new Outreach OAuth2 API credential
- Enter your Client ID and Client Secret
- Complete OAuth flow
Usage Examples
Create a New Prospect
{
"resource": "prospect",
"operation": "upsert",
"email": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"company": "Example Corp"
}Send an Email
{
"resource": "mailing",
"operation": "create",
"prospectId": "123",
"mailboxId": "456",
"subject": "Welcome!",
"bodyHtml": "<h1>Welcome!</h1><p>Thanks for joining us.</p>"
}Add to Sequence
{
"resource": "sequenceState",
"operation": "create",
"prospectId": "123",
"sequenceId": "789"
}Node Configuration
Resources
- Prospect: Manage prospect data and relationships
- Mailing: Send emails and track delivery
- Sequence State: Manage prospect sequences
Operations
- Upsert: Create or update records
- Create: Create new records
- Get: Retrieve individual records
- Get All: Retrieve multiple records
Advanced Features
- Upsert Logic: Automatically handles create vs update based on email lookup
- Relationship Management: Supports prospect-account-owner relationships
- Template Integration: Load and use Outreach email templates
- Pagination: Automatic handling of large result sets
- Error Handling: Robust error handling with retry logic
API Coverage
This node supports the following Outreach.io API endpoints:
- Prospects:
/prospects(CRUD operations) - Mailings:
/mailings(Create and send emails) - Sequences:
/sequences(Sequence management) - Sequence States:
/sequenceStates(Prospect sequence enrollment) - Templates:
/templates(Email templates) - Mailboxes:
/mailboxes(Sender mailboxes)
Development
Requirements
- Node.js ≥ 18
- npm ≥ 8
- n8n (for testing)
Setup
git clone https://github.com/alkali-partners/n8n-nodes-outreachio.git
cd n8n-nodes-outreachio
npm installDevelopment Commands
npm run build # Build the node
npm run build:watch # Build and watch for changes
npm run dev # Start n8n in development mode
npm run lint # Run linting
npm run test # Run tests
npm run test:coverage # Run tests with coverageTesting
# Run all tests
npm run test
# Run specific test suites
npm run test:unit
npm run test:integration
npm run test:transport
# Run with coverage
npm run test:coverageContributing
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests
- Run
npm run check:all - Submit a pull request
Changelog
See CHANGELOG.md for release history.
License
Support
- Issues: GitHub Issues
- Documentation: Outreach.io API Docs
- n8n Community: n8n Community Forum
About Alkali Partners
Alkali Partners specializes in sales automation and business process optimization. This node is part of our commitment to the open-source community.
Note: This is a community-developed node and is not officially supported by Outreach.io or n8n.
