npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

n8n-nodes-pautapy

v1.2.1

Published

n8n plugin for SparkBot

Downloads

8

Readme

n8n plugin for SparkBot WhatsApp API

License NPM Version

SparkBot n8n plugin

This is an n8n community node that integrates SparkBot's WhatsApp API functionality into your n8n workflows.

Send WhatsApp messages, upload media files, validate phone numbers, manage chats, contacts, team members, departments, and more - all within your automated workflows.

SparkBot is a versatile WhatsApp Team Chat and API solution for business messaging to automate anything on WhatsApp.

Check out the API documentation and examples here

Product update: 🚀 no more need to host n8n on your own, try SparkBot Flows today for a fully managed WhatsApp No-Code Automation Workflows ⚡✨

🚀 Ready to Build WhatsApp Automations?

Get started with step-by-step tutorials and real-world examples:

Popular automation ideas:

  • AI-powered customer support bots
  • Lead qualification workflows
  • Order status notifications
  • Appointment booking systems
  • Multi-language customer support with business-specific trained data

Start building your first WhatsApp automation in minutes! 💡

Contents

Requirements

Installation

Community Nodes (Recommended)

  1. Go to Settings > Community Nodes
  2. Select Install
  3. Enter n8n-nodes-pautapy in the "Enter npm package name" field
  4. Agree to the risks of using community nodes: select "I understand the risks of installing unverified code from a public source"
  5. Select Install
  6. You can now use SparkBot's node in your workflows: if you can't see it, restart n8n instance

Manual installation

To get started, install the package in your n8n root directory:

# Using npm
npm install n8n-nodes-pautapy

# Alternatively, for Docker-based installations
docker exec -it n8n npm install n8n-nodes-pautapy

After installation, restart your n8n instance.

Setup

  1. Go to Credentials
  2. Select Add Credential button
  3. Select SparkBot from the "Search for app" dropdown
  4. Enter your SparkBot API key in the API Key field
  5. Select Save to store your credentials

Features

Send Text Messages

  • Send formatted text messages to any WhatsApp user
  • Support for rich text formatting (bold, italic, monospace, strikethrough)
  • Add URLs with preview capability
  • Include emojis and special characters
  • Send to individual contacts or broadcast to multiple recipients

Send Multimedia Messages

  • Send images, videos, documents, and audio files
  • Support for GIFs and stickers
  • Upload files by URL or from local storage
  • Add captions to media messages
  • Set media message attributes (filename, mimetype, etc.)

Schedule Messages

  • Schedule messages for future delivery
  • Set specific date and time for delivery
  • Schedule recurring messages with external triggers
  • Cancel scheduled messages before delivery

Contacts Management

  • Validate if phone numbers exist on WhatsApp
  • Check contact's profile information
  • Add contacts to your address book
  • Create and manage contact groups

Webhooks & Real-time Events

  • Process incoming messages via webhooks
  • React to message status updates (sent, delivered, read)
  • Handle group events (joins, leaves, topic changes)
  • Monitor connection status changes
  • Receive call notifications

Templates & Automation

  • Send template messages for business accounts
  • Use message variables for personalization
  • Create automated reply workflows
  • Set up conditional message flows based on responses

Advanced Features

  • Send interactive buttons and list messages
  • Create polls and gather responses
  • Send location messages
  • Implement quick reply buttons
  • Handle message reactions

Utility Functions

  • Download and process media from incoming messages
  • Generate QR codes for WhatsApp Web login
  • Monitor device battery and connection status
  • Manage multiple WhatsApp accounts from a single workflow

Configuring n8n Webhooks for External Access

To receive events from SparkBot or other external services, you'll need to configure n8n with a publicly accessible URL. By default, n8n runs locally and generates webhook URLs using localhost, which external services cannot reach.

Understanding Webhook Configuration

n8n creates webhook URLs by combining the protocol, host, and port settings. When running behind a reverse proxy or needing public access, you must manually set the webhook URL.

Setting the Webhook URL

Temporary Configuration (Session Only)
Mac / Linux
export WEBHOOK_URL=https://your-domain.com/
n8n start
Windows (Command Prompt)
set WEBHOOK_URL=https://your-domain.com/
n8n start
Windows (PowerShell)
$env:WEBHOOK_URL = "https://your-domain.com/"
n8n start
Permanent Configuration
Mac / Linux

Add to your ~/.bashrc, ~/.zshrc, or appropriate shell configuration file:

echo 'export WEBHOOK_URL=https://your-domain.com/' >> ~/.bashrc
source ~/.bashrc
Windows

Set a system environment variable through:

  1. Right-click on 'This PC' or 'My Computer' → Properties
  2. Click 'Advanced system settings'
  3. Click 'Environment Variables'
  4. Add a new system variable with:
    • Name: WEBHOOK_URL
    • Value: https://your-domain.com/

Verifying Your Webhook Configuration

  1. Start n8n after setting the webhook URL
  2. Create a new workflow and add an "SparkBot" node that uses webhooks
  3. The webhook URL should now show your custom domain instead of localhost
  4. External services can now successfully send events to your n8n instance

Note: Ensure your domain is properly set up with SSL and that your network/firewall allows incoming connections to the port your n8n instance is using.

Using ngrok for Public Webhook URLs

If you're developing locally and need a quick way to expose your n8n instance to the internet for testing webhooks, ngrok is a great solution.

Installing ngrok

Mac
# Using Homebrew
brew install ngrok

Or download and install manually here

Linux

Follow the instructions described here

Windows
  1. Download ngrok from https://ngrok.com/download
  2. Extract the zip file
  3. Optionally, add the ngrok executable to your PATH or move it to a directory that's already in your PATH

Alternatively follow the instructions here

Setting Up ngrok

  1. Sign up for a free account at https://ngrok.com
  2. Get your auth token from the ngrok dashboard
  3. Configure ngrok with your auth token:
    ngrok authtoken YOUR_AUTH_TOKEN

Using ngrok with n8n

  1. Start your n8n instance first:

    n8n start
  2. In a new terminal window, start ngrok pointing to n8n's default port:

    ngrok http 5678
  3. Ngrok will display a URL like https://abc123.ngrok.io

  4. Set this as your n8n webhook URL in a new terminal:

    Mac/Linux:

    export WEBHOOK_URL=https://abc123.ngrok.io/
    n8n start

    Windows (Command Prompt):

    set WEBHOOK_URL=https://abc123.ngrok.io/
    n8n start

    Windows (PowerShell):

    $env:WEBHOOK_URL = "https://abc123.ngrok.io/"
    n8n start
  5. You'll need to restart n8n for the webhook URL changes to take effect

Example Workflow

  1. Start n8n on port 5678
  2. Launch ngrok: ngrok http 5678
  3. Note the ngrok URL (e.g., https://abc123.ngrok.io)
  4. Stop n8n
  5. Set the webhook URL environment variable with the ngrok URL
  6. Restart n8n
  7. Create a workflow with a SparkBot webhook trigger
  8. The webhook URL will now use your ngrok domain and be accessible from the internet

Note: Free ngrok sessions expire after a few hours and the URL changes each time you restart ngrok. For production use, consider a permanent solution like a proper domain with a reverse proxy.

License

MIT