Back to Activepieces

WhatsScale

packages/pieces/community/whatsscale/README.md

0.82.14.4 KB
Original Source

WhatsScale

WhatsApp automation for Activepieces — send messages, manage contacts, and automate workflows through WhatsApp.

Authentication

WhatsScale uses API key authentication. Get your key from whatsscale.com/dashboard.

Actions

Send Text

ActionDescription
Send a Message (Manual Entry)Send text by entering phone number or group ID manually
Send a Message to a ContactSend text to a WhatsApp contact (dropdown)
Send a Message to a GroupSend text to a WhatsApp group (dropdown)
Send a Text to a ChannelBroadcast text to a WhatsApp Channel (dropdown)
Send a Message to a CRM ContactSend text to a WhatsScale CRM contact (dropdown)

Send Image

ActionDescription
Send an Image to a ContactSend image to a WhatsApp contact (dropdown)
Send an Image to a GroupSend image to a WhatsApp group (dropdown)
Send an Image to a ChannelBroadcast image to a WhatsApp Channel (dropdown)
Send an Image to a CRM ContactSend image to a WhatsScale CRM contact (dropdown)
Send an Image (Manual Entry)Send image by entering phone number or group ID manually

Send Video

ActionDescription
Send a Video to a ContactSend video to a WhatsApp contact (dropdown)
Send a Video to a GroupSend video to a WhatsApp group (dropdown)
Send a Video to a ChannelBroadcast video to a WhatsApp Channel (dropdown)
Send a Video to a CRM ContactSend video to a WhatsScale CRM contact (dropdown)
Send a Video (Manual Entry)Send video by entering phone number or group ID manually

Send Document

ActionDescription
Send a Document to a ContactSend document (PDF, DOCX, XLSX, etc.) to a contact (dropdown)
Send a Document to a GroupSend document to a WhatsApp group (dropdown)
Send a Document to a CRM ContactSend document to a WhatsScale CRM contact (dropdown)

Send Location

ActionDescription
Send a Location to a ContactSend a GPS location pin to a WhatsApp contact (dropdown)
Send a Location to a GroupSend a GPS location pin to a WhatsApp group (dropdown)
Send a Location to a CRM ContactSend a GPS location pin to a WhatsScale CRM contact (dropdown)

Send Poll

ActionDescription
Send a Poll to a ContactSend a poll with options to a WhatsApp contact (dropdown)
Send a Poll to a GroupSend a poll with options to a WhatsApp group (dropdown)
Send a Poll to a ChannelBroadcast a poll to a WhatsApp Channel (dropdown)
Send a Poll to a CRM ContactSend a poll to a WhatsScale CRM contact (dropdown)

Set Story

ActionDescription
Set a Text StoryPost a text status update to your WhatsApp story with optional background color
Set an Image StoryPost an image to your WhatsApp story with optional caption
Set a Video StoryPost a video to your WhatsApp story with optional caption

CRM Contacts

ActionDescription
Create a CRM ContactCreate a new contact with phone, name, and tags
Get a CRM ContactRetrieve a contact by ID (dropdown)
Find a CRM Contact by PhoneLook up a contact by phone number (with country code)
Update a CRM ContactUpdate name and/or tags of an existing contact
Delete a CRM ContactPermanently delete a contact
Add a Tag to a CRM ContactAdd a single tag to a contact
Remove a Tag from a CRM ContactRemove a single tag from a contact
List CRM ContactsRetrieve contacts with optional tag filter and pagination

Planned (Sprints 8-10)

  • Check WhatsApp Number
  • Make an API Call
  • Triggers: Watch Incoming Messages, Group Messages, Channel Messages

Architecture

Activepieces Flow
       │
       ▼
proxy.whatsscale.com
       │
   ┌───┴───┐
   ▼       ▼
 WAHA    Supabase
(WhatsApp) (CRM)

All actions communicate through the WhatsScale proxy, which handles authentication, file preparation, and async job polling.

Media URL Support

All image, video, and document actions support:

  • Direct URLs (JPEG, PNG, MP4, PDF, DOCX, etc.)
  • Google Drive share links
  • Dropbox share links
  • Any publicly accessible URL