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: 34 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.
n8n Cloud
Search for "Vybit" in the n8n nodes panel to install. On n8n Cloud, the OAuth2 credential is pre-configured through n8n's Managed OAuth: click Connect my account, sign in to Vybit, and you're done. No OAuth app registration is needed.
For Multi-User Deployments
See DEPLOYMENT.md for configuring credential sharing in self-hosted 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
n8n Cloud:
- Add a Vybit node, Authentication: "OAuth2"
- Create a new Vybit OAuth2 credential and click Connect my account
- Sign in to Vybit and approve access
Self-hosted n8n:
- Go to developer.vybit.net and open the OAuth configuration
- Set a service name and add your n8n callback as a redirect URI:
https://your-n8n-host/rest/oauth2-credential/callback - In n8n:
- Add Vybit node
- Authentication: "OAuth2"
- Create OAuth2 credential with your client ID/secret
- Users authorize their Vybit accounts to connect
See Credentials for details on both credential types.
Credentials
The node ships two credential types. Both give access to every operation.
Vybit OAuth2 API
Standard OAuth2 authorization code flow against your Vybit account.
| Setting | Value |
|---|---|
| Authorization URL | https://app.vybit.net |
| Access Token URL | https://app.vybit.net/service/token |
| Scopes | none (full access to the authorizing account) |
| Client authentication | client ID and secret in the request body |
| Token lifetime | long-lived, no refresh token |
On n8n Cloud the client ID and secret are managed by n8n, so the credential form only shows a Connect my account button. Anyone who prefers their own OAuth app can still enter a client ID and secret.
On self-hosted n8n you register your own OAuth app at developer.vybit.net. Up to three redirect URIs can be registered per app, so a production callback, a staging callback, and http://localhost for local development can share one client. The n8n callback path is always /rest/oauth2-credential/callback on your n8n host.
Vybit API
A Developer API key from developer.vybit.net, sent as the X-API-Key header. Use it for automating your own account or for backend services. The base URL defaults to https://api.vybit.net/v1.
Available Operations
All 34 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 |
| Play | Get the playback URL for a sound |
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 uses n8n's built-in httpRequestWithAuthentication helper for all API calls (no bundled SDK). API endpoint paths are maintained in Vybit.node.ts and must be kept in sync with @vybit/api-sdk when the API changes.
Building
npm run build
Testing Locally
Using Docker (recommended):
# See docker-compose.yml in the project root's my-n8n directory
# The dist is volume-mounted into the container via N8N_CUSTOM_EXTENSIONS
docker compose up -d
Using npm link:
npm link
cd /path/to/n8n
npm link @vybit/n8n-nodes-vybit
n8n start
Integration Tests
# Requires a running n8n instance with a configured Vybit API Key credential
export N8N_API_KEY="your-n8n-api-key"
export VYBIT_API_CREDENTIAL_ID="your-credential-id"
node test/integration/test-runner.js
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