Package Information
Documentation
@vybit/n8n-nodes-vybit
Official n8n community nodes for Vybit - the personalized audio notification platform.
Features
- Dual Authentication: API Key for personal automation or OAuth2 for multi-user services
- Push Notifications: Send personalized audio notifications from your workflows
- Full API Access: 33 operations across 7 resources, available with either auth method
- Manage Vybits: Create, update, trigger, and delete vybits programmatically
- Subscriptions & Peeps: Subscribe to vybits and manage access invitations
- Reminders: Create and manage scheduled reminders on vybits
- Sounds & Logs: Search sounds and view notification history
- Zero Dependencies: Built with zero runtime dependencies
Installation
Self-Hosted n8n
npm install @vybit/n8n-nodes-vybit
Then restart your n8n instance.
For Multi-User Deployments
See DEPLOYMENT.md for configuring credential sharing in multi-user n8n instances to centrally manage OAuth2 Client Secrets.
Which Authentication Method Should I Use?
Both methods provide full access to all operations. Choose based on your use case:
Use API Key if:
- You're automating your own Vybit account
- Building personal workflows (e.g., "alert me when server is down")
- Integrating Vybit into your backend service
Example: DevOps engineer using n8n to trigger their personal Vybit when monitoring detects issues
Use OAuth2 if:
- You're building a service where users connect their own accounts
- Each user needs to authorize their own Vybit account
- Multi-tenant scenarios (agency managing client notifications)
Example: Agency building n8n workflows that send notifications to client Vybit accounts
Quick Start
API Key Setup
- Go to developer.vybit.net
- Generate an API key
- In n8n:
- Add Vybit node
- Authentication: "API Key"
- Create new credential and paste your API key
OAuth2 Setup
- Go to developer.vybit.net
- Configure OAuth2 settings (client ID, redirect URI)
- In n8n:
- Add Vybit node
- Authentication: "OAuth2"
- Create OAuth2 credential with your client ID/secret
- Users authorize their Vybit accounts to connect
Available Operations
All 33 operations are available with both API Key and OAuth2 authentication.
Profile
| Operation | Description |
|---|---|
| Get Profile | View account information |
| Get Usage Metrics | View current usage and tier limits |
| Check API Status | Check API service health |
Vybits
| Operation | Description |
|---|---|
| List | Get all vybits |
| Get | Get vybit details |
| Create | Create a new vybit |
| Update | Update vybit settings |
| Delete | Delete a vybit |
| Trigger | Send a push notification |
Subscriptions
| Operation | Description |
|---|---|
| List Public Vybits | Browse publicly available vybits |
| Get Public Vybit | Get details of a public vybit |
| Subscribe | Subscribe to a vybit |
| List My Subscriptions | Get your subscriptions |
| Get Subscription | Get subscription details |
| Update Subscription | Update subscription settings |
| Unsubscribe | Unsubscribe from a vybit |
| Send to Owner | Send notification to vybit owner |
| Send to Group | Send notification to all subscribers |
Sounds
| Operation | Description |
|---|---|
| Search | Search available sounds |
| Get | Get sound details |
Logs
| Operation | Description |
|---|---|
| List All | View all notification logs |
| Get | Get specific log entry details |
| List by Vybit | View logs for a specific vybit |
| List by Subscription | View logs for a subscription |
Peeps
| Operation | Description |
|---|---|
| List All | View all peep invitations |
| List by Vybit | View peeps for a specific vybit |
| Invite | Invite a user to a vybit |
| Get | Get peep details |
| Delete | Remove a peep invitation |
Reminders
| Operation | Description |
|---|---|
| List | List all reminders on a vybit |
| Create | Create a new scheduled reminder |
| Update | Update an existing reminder |
| Delete | Delete a reminder |
Example Workflows
Trigger Alert on Server Error
Webhook (error event)
→ Vybit (Trigger)
Daily Summary Notification
Schedule (daily at 9am)
→ HTTP Request (fetch metrics)
→ Vybit (Trigger with summary)
Create Vybit from Airtable
Airtable Trigger (new record)
→ Vybit (Create vybit)
→ Vybit (Trigger, send notification)
Development
This package bundles @vybit/api-sdk and @vybit/oauth2-sdk to meet n8n's verified node requirements (zero runtime dependencies).
Building
npm run build
Testing Locally
npm link
cd /path/to/n8n
npm link @vybit/n8n-nodes-vybit
n8n start
Resources
Related Packages
Part of the Vybit SDK monorepo:
- @vybit/api-sdk - Developer API client
- @vybit/oauth2-sdk - OAuth2 client
- @vybit/mcp-server - MCP server for AI assistants
License
MIT © Flatirontek LLC
