evolution-api_skill

This skill helps you automate WhatsApp workflows using Evolution API v2.3, managing messages, groups, chatbots, webhooks, and Chatwoot integrations.

Python

2.5k

GitHub Stars

2

Bundled Files

2 months ago

Catalog Refreshed

4 months ago

First Indexed

Readme & install

Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.

Installation

Preview and clipboard use veilstrat where the catalogue uses aiagentskills.

npx veilstrat add skill openclaw/skills --skill evolution-api

_meta.json282 B
SKILL.md35.5 KB

Overview

This skill implements complete WhatsApp automation using Evolution API v2.3. It manages instances, sends all message types (text, media, polls, lists, buttons, status), administers groups and labels, and integrates chatbots, webhooks, proxy, S3 storage, and Chatwoot. It is focused on programmatic control of WhatsApp instances for automation and customer engagement.

How this skill works

The skill talks to Evolution API v2.3 endpoints using two API key levels: a global admin key for instance management and an instance token for messaging operations. It exposes endpoints for instance lifecycle, settings, proxy, message sending (including media upload and base64 extraction), chat operations, labels, and integrations with chatbot engines and Chatwoot. Use standard REST calls with JSON or multipart/form-data for uploads, and scan the returned QR code to pair WhatsApp sessions.

When to use it

Automating customer messaging and support via WhatsApp at scale
Connecting WhatsApp flows to chatbots (OpenAI, Typebot, Dify, Flowise, N8N, EvoAI)
Integrating WhatsApp with Chatwoot for unified inbox and ticketing
Sending multimedia campaigns, polls, lists, or buttons requiring rich interaction
Managing multiple WhatsApp instances with proxy or S3 storage requirements

Best practices

Keep two separate API keys: global for admin tasks and instance tokens for messaging to minimize risk
Respect rate limits by using the delay parameter on bulk sends (e.g., delay: 1200 ms)
Use webhook or RabbitMQ/SQS options for reliable event delivery and to avoid polling
Store large media in S3 and send URLs or use multipart uploads to reduce memory usage
Limit sensitive operations to secure environments and rotate keys regularly

Example use cases

Automated support bot: webhook events route messages to OpenAI or Flowise and reply via sendText/sendButtons
Onboarding flows: use sendList and sendButtons to guide new users through setup steps
Broadcast updates: sendStatus or sendMedia to share stories and announcements to selected contacts
Contact management: add/remove labels and import messages to Chatwoot for ticket creation
Group automation: create and manage groups, post scheduled media or polls for engagement

FAQ

Call the connect endpoint for your instance and scan the returned base64 QR code or pass a number to receive a pairing code.

Which authentication keys are required?

Use the global API key (apikey header) for admin endpoints and the instance API key for messaging, chat, labels, and profile endpoints.

How should I send large media files?

Prefer S3-hosted URLs or multipart/form-data uploads; use the convertToMp4 option when extracting audio to get MP4 output.