Help Desk
  • Getting Started
    • 🙌Welcome to Whapi.Cloud
    • 💰Pricing
    • ☕Partners
    • 🚀Getting started
    • 👨‍💻API Docs
      • Developer hubs
      • Swagger environment
      • Postman collection
  • Sending
    • Introduction
    • Send text message
      • Whatsapp API send message PHP
      • Whatsapp API send message Python
      • Whatsapp API send message Node JS
      • Whatsapp API send message С#
      • Whatsapp API send message Java
      • API integration with VB6
      • Whatsapp API send message GO (Golang)
    • Send video, audio, image, document
      • How to send file from your local computer using the API
    • Send Group message
    • Send post to WhatsApp Channel
    • Send message with Buttons
    • Send Emoji
    • Overview of other methods for sending
      • Send Voice message
      • Send contact (vCard)
      • Send message reactions
  • Receiving
    • Introduction
    • Webhooks
      • Our webhooks (Tracked events)
      • Where to Find the Webhook URL?
      • Set the webhook link to the channel
      • Detailed webhook settings
      • How to check the webhook?
      • Incoming webhooks format
        • Incoming message
        • Sent message
        • Chats
          • How to Track Chat Labels via Webhook
        • Groups
        • Communities
        • Contacts
        • Account and device status
        • Other
          • Calls
          • Presences
          • Labels
          • Views of stories (statuses)
          • Story (status) from your contacts
      • Receive messages
        • Receive WhatsApp messages using PHP
        • Receive WhatsApp messages using Node js
        • Receive WhatsApp messages using Python
    • HTTP API
      • Retrieve a Specific User's Chat History
      • Get a full-size picture in the response
      • Get order items
      • Get a profile picture of a chat or user
    • File expiration period
  • Groups
    • Send Group message
      • Mentioning all participants in a WhatsApp group
    • Get list of group members
    • Add new member to Group
  • Channels
    • Send post to WhatsApp Channel
    • Get messages from Channels
    • Get votes from polls in the Channel
  • Communities
    • Introduction
    • Create a community
    • Add a member to a community
    • Send announcement
    • Get info on community participants
    • Add a group / Exclude a group from the community
  • Account
    • Setting "Auto Download"
    • Customizable Webhook Headers
    • How to find out the IP channel
    • How to Delete a Channel
    • Add Business Info to Invoice
  • Source code
    • WhatsApp ChatBot
      • WhatsApp Python Bot
      • WhatsApp PHP Bot
      • WhatsApp Node JS Bot
      • WhatsApp Java Bot
    • WhatsApp API Google Sheets
    • WhatsApp Phone Number Checker
    • Request Distributor (Balancer)
  • FAQ
    • Does WhatsApp API work with the phone turned off?
    • Chat ID. What is it and how to get it?
    • Why do I see status "pending" after sending message?
    • How to send a paragraph (line break)
    • Inactive Links in WhatsApp Messages
    • WhatsApp Text Formatting
    • Checking if the number has Whatsapp
    • Specifics of sending messages to numbers of different countries
    • Current status of Buttons on WhatsApp
    • Why aren't participants being added to the group?
  • Hints
    • Android Emulators
    • Virtual Numbers for WhatsApp
    • How to use polls as buttons?
    • How to check who blocked you in Whatsapp?
    • Setting up a WhatsApp proxy
  • Integrations
    • Make.com
      • Ready-Made Scenarios
        • WhatsApp & Whisper API: Voice-to-Text Integration
        • Automated WhatsApp Group Message Forwarding in Make.com
      • Request Scenario Setup
    • Pabbly Connect
    • Google Contacts
    • DialogFlow
    • n8n
  • Tools
    • WhatsApp Number Checker
    • Automatic warm-up module
    • WhatsApp Activity Safety Meter
    • Residential Proxies from Whapi.Cloud
  • Troubleshooting
    • Couldn't Link Device – WhatsApp QR Code or Pairing Code Fails
    • Channel status “SYNC_ERROR”
    • Not getting a READ status on webhook
    • 429 (Too Many Requests) - Soft Ban
    • “Waiting for this message. This may take a while” – WhatsApp Message Error
    • Missing push notifications after connecting to API
  • Blocking
    • How to not get Banned?
    • How to do mailings without the risk of being blocked?
    • If My Number Is Banned, Can It Be Restored?
    • Unlocking Your WhatsApp Number
    • Connecting a New WhatsApp Number After a Ban: Steps and Recommendations
    • Warming Up New Phone Numbers for WhatsApp API
  • Partner Documentation
    • Introduction
    • Partner Dashboard Overview
    • Partner Program Guidelines
      • Workflow: Step-by-Step
      • Billing for Partners
      • Allocating Days to Customer Channels: Best Practices & Guide
      • Interface for channel management
    • Partner Documentation
      • Channel creation
      • Changing channel mode
      • Channel extension
      • Channel deletion
      • Getting the list of channels
      • Notices of end of days on balance
Powered by GitBook
On this page

Was this helpful?

  1. Integrations

n8n

Installation Guide for Whapi.Cloud Custom Node in n8n

PreviousDialogFlowNextWhatsApp Number Checker

Last updated 5 months ago

Was this helpful?

To use the Whapi.Cloud API integration via n8n, follow these steps:

Step 1: Setting Up n8n with Docker

First, you need to set up n8n. The easiest way to do this is by using Docker. Here’s how to get started:

  1. Install Docker on your machine if it's not already installed. You can find installation instructions .

  2. Pull the n8n Docker image using the following command:

    docker pull n8nio/n8n

    You can find the Docker image and detailed instructions on how to configure n8n via Docker .

  3. Once the image is pulled, you can start n8n by running:

    docker run -it --rm \
    -p 5678:5678 \
    -v ~/.n8n:/home/node/.n8n \
    n8nio/n8n

    This command starts n8n on port 5678, and it also ensures that any saved workflows and credentials are persistent between restarts by mounting the directory ~/.n8n.

Important: We recommend reviewing the full setup details on Docker Hub, as it includes information on setting up environment variables, data persistence, and scaling n8n. Since we do not provide support for the general usage of n8n, it’s essential to familiarize yourself with these resources.

Step 2: Installing the Whapi.Cloud Custom Node

Once you’ve successfully installed and configured n8n, the next step is to add the Whapi.Cloud integration as a community node. There are two ways to do this: via the GUI or manually.

Option 1: Installing via GUI

  1. Open the n8n interface by navigating to http://localhost:5678 in your web browser.

  2. Go to Settings in the top-right corner of the page.

  3. Select Community Nodes.

  4. In the community nodes section, search for n8n-nodes-whapi.

  5. Follow the on-screen instructions to complete the installation.

Option 2: Manual Installation

If you prefer to install the custom node manually, follow these steps:

  1. Open a terminal and navigate to the directory where your n8n installation is located.

  2. Run the following command to install the Whapi.Cloud node module:

    npm install n8n-nodes-whapi
  3. After the installation is complete, restart the n8n instance for the changes to take effect.

Step 3: Using the Integration

After completing the installation, you can start creating workflows using the Whapi.Cloud integration:

  1. Choose appropriate triggers and actions that correspond to the Whapi.Cloud API.

  2. Add steps to automate processes involving your Whapi.Cloud account.

  3. Use the predefined actions or create custom API calls if you need more flexibility. Our Whapi.Cloud API documentation provides everything you need to expand your workflows.

For more detailed steps, refer to the official n8n documentation on community node installation via GUI .

For detailed manual installation steps, you can refer to the .

If the available actions don’t cover all your needs, you can use custom API calls to implement any functionality using .

here
on the official Docker Hub page
here
n8n manual installation guide
our documentation