Get the FREE Ultimate OpenClaw Setup Guide →

automate-whatsapp

Scanned
npx machina-cli add skill gokapso/agent-skills/automate-whatsapp --openclaw
Files (1)
SKILL.md
10.5 KB

Automate WhatsApp

When to use

Use this skill to build and run WhatsApp automations: workflow CRUD, graph edits, triggers, executions, function management, app integrations, and D1 database operations.

Setup

Env vars:

  • KAPSO_API_BASE_URL (host only, no /platform/v1)
  • KAPSO_API_KEY

How to

Edit a workflow graph

  1. Fetch graph: node scripts/get-graph.js <workflow_id> (note the lock_version)
  2. Edit the JSON (see graph rules below)
  3. Validate: node scripts/validate-graph.js --definition-file <path>
  4. Update: node scripts/update-graph.js <workflow_id> --expected-lock-version <n> --definition-file <path>
  5. Re-fetch to confirm

For small edits, use edit-graph.js with --old-file and --new-file instead.

If you get a lock_version conflict: re-fetch, re-apply changes, retry with new lock_version.

Manage triggers

  1. List: node scripts/list-triggers.js <workflow_id>
  2. Create: node scripts/create-trigger.js <workflow_id> --trigger-type <type> --phone-number-id <id>
  3. Toggle: node scripts/update-trigger.js --trigger-id <id> --active true|false
  4. Delete: node scripts/delete-trigger.js --trigger-id <id>

For inbound_message triggers, first run node scripts/list-whatsapp-phone-numbers.js to get phone_number_id.

Debug executions

  1. List: node scripts/list-executions.js <workflow_id>
  2. Inspect: node scripts/get-execution.js <execution-id>
  3. Get value: node scripts/get-context-value.js <execution-id> --variable-path vars.foo
  4. Events: node scripts/list-execution-events.js <execution-id>

Create and deploy a function

  1. Write code with handler signature (see function rules below)
  2. Create: node scripts/create-function.js --name <name> --code-file <path>
  3. Deploy: node scripts/deploy-function.js --function-id <id>
  4. Verify: node scripts/get-function.js --function-id <id>

Set up agent node with app integrations

  1. Find model: node scripts/list-provider-models.js
  2. Find account: node scripts/list-accounts.js --app-slug <slug> (use pipedream_account_id)
  3. Find action: node scripts/search-actions.js --query <word> --app-slug <slug> (action_id = key)
  4. Create integration: node scripts/create-integration.js --action-id <id> --app-slug <slug> --account-id <id> --configured-props <json>
  5. Add tools to agent node via flow_agent_app_integration_tools

Database CRUD

  1. List tables: node scripts/list-tables.js
  2. Query: node scripts/query-rows.js --table <name> --filters <json>
  3. Create/update/delete with row scripts

Graph rules

  • Exactly one start node with id = start
  • Never change existing node IDs
  • Use {node_type}_{timestamp_ms} for new node IDs
  • Non-decide nodes have 0 or 1 outgoing next edge
  • Decide edge labels must match conditions[].label
  • Edge keys are source/target/label (not from/to)

For full schema details, see references/graph-contract.md.

Function rules

async function handler(request, env) {
  // Parse input
  const body = await request.json();
  // Use env.KV and env.DB as needed
  return new Response(JSON.stringify({ result: "ok" }));
}
  • Do NOT use export, export default, or arrow functions
  • Return a Response object

Execution context

Always use this structure:

  • vars - user-defined variables
  • system - system variables
  • context - channel data
  • metadata - request metadata

Scripts

Workflows

ScriptPurpose
list-workflows.jsList workflows (metadata only)
get-workflow.jsGet workflow metadata
create-workflow.jsCreate a workflow
update-workflow-settings.jsUpdate workflow settings

Graph

ScriptPurpose
get-graph.jsGet workflow graph + lock_version
edit-graph.jsPatch graph via string replacement
update-graph.jsReplace entire graph
validate-graph.jsValidate graph structure locally

Triggers

ScriptPurpose
list-triggers.jsList triggers for a workflow
create-trigger.jsCreate a trigger
update-trigger.jsEnable/disable a trigger
delete-trigger.jsDelete a trigger
list-whatsapp-phone-numbers.jsList phone numbers for trigger setup

Executions

ScriptPurpose
list-executions.jsList executions
get-execution.jsGet execution details
get-context-value.jsRead value from execution context
update-execution-status.jsForce execution state
resume-execution.jsResume waiting execution
list-execution-events.jsList execution events

Functions

ScriptPurpose
list-functions.jsList project functions
get-function.jsGet function details + code
create-function.jsCreate a function
update-function.jsUpdate function code
deploy-function.jsDeploy function to runtime
invoke-function.jsInvoke function with payload
list-function-invocations.jsList function invocations

App integrations

ScriptPurpose
list-apps.jsSearch integration apps
search-actions.jsSearch actions (action_id = key)
get-action-schema.jsGet action JSON schema
list-accounts.jsList connected accounts
create-connect-token.jsCreate OAuth connect link
configure-prop.jsResolve remote_options for a prop
reload-props.jsReload dynamic props
list-integrations.jsList saved integrations
create-integration.jsCreate an integration
update-integration.jsUpdate an integration
delete-integration.jsDelete an integration

Databases

ScriptPurpose
list-tables.jsList D1 tables
get-table.jsGet table schema + sample rows
query-rows.jsQuery rows with filters
create-row.jsCreate a row
update-row.jsUpdate rows
upsert-row.jsUpsert a row
delete-row.jsDelete rows

OpenAPI

ScriptPurpose
openapi-explore.mjsExplore OpenAPI (search/op/schema/where)

Install deps (once):

npm i

Examples:

node scripts/openapi-explore.mjs --spec workflows search "variables"
node scripts/openapi-explore.mjs --spec workflows op getWorkflowVariables
node scripts/openapi-explore.mjs --spec platform op queryDatabaseRows

Notes

  • Prefer file paths over inline JSON (--definition-file, --code-file)
  • action_id is the same as key from search-actions
  • --account-id uses pipedream_account_id from list-accounts
  • Variable CRUD (variables-set.js, variables-delete.js) is blocked - Platform API doesn't support it
  • Raw SQL execution is not supported via Platform API

References

Read before editing:

Other references:

Assets

FileDescription
workflow-linear.jsonMinimal linear workflow
workflow-decision.jsonMinimal branching workflow
workflow-agent-simple.jsonMinimal agent workflow
workflow-customer-support-intake-agent.jsonCustomer support intake
workflow-interactive-buttons-decide-function.jsonInteractive buttons + decide (function)
workflow-interactive-buttons-decide-ai.jsonInteractive buttons + decide (AI)
workflow-api-template-wait-agent.jsonAPI trigger + template + agent
function-decide-route-interactive-buttons.jsonFunction for button routing
agent-app-integration-example.jsonAgent node with app integrations

Related skills

  • integrate-whatsapp - Onboarding, webhooks, messaging, templates, flows
  • observe-whatsapp - Debugging, logs, health checks
<!-- FILEMAP:BEGIN -->
[automate-whatsapp file map]|root: .
|.:{package.json,SKILL.md}
|assets:{agent-app-integration-example.json,databases-example.json,function-decide-route-interactive-buttons.json,functions-example.json,workflow-agent-simple.json,workflow-api-template-wait-agent.json,workflow-customer-support-intake-agent.json,workflow-decision.json,workflow-interactive-buttons-decide-ai.json,workflow-interactive-buttons-decide-function.json,workflow-linear.json}
|references:{app-integrations.md,databases-reference.md,execution-context.md,function-contracts.md,functions-payloads.md,functions-reference.md,graph-contract.md,node-types.md,triggers.md,workflow-overview.md,workflow-reference.md}
|scripts:{configure-prop.js,create-connect-token.js,create-function.js,create-integration.js,create-row.js,create-trigger.js,create-workflow.js,delete-integration.js,delete-row.js,delete-trigger.js,deploy-function.js,edit-graph.js,get-action-schema.js,get-context-value.js,get-execution-event.js,get-execution.js,get-function.js,get-graph.js,get-table.js,get-workflow.js,invoke-function.js,list-accounts.js,list-apps.js,list-execution-events.js,list-executions.js,list-function-invocations.js,list-functions.js,list-integrations.js,list-provider-models.js,list-tables.js,list-triggers.js,list-whatsapp-phone-numbers.js,list-workflows.js,openapi-explore.mjs,query-rows.js,reload-props.js,resume-execution.js,search-actions.js,update-execution-status.js,update-function.js,update-graph.js,update-integration.js,update-row.js,update-trigger.js,update-workflow-settings.js,upsert-row.js,validate-graph.js,variables-delete.js,variables-list.js,variables-set.js}
|scripts/lib/databases:{args.js,filters.js,kapso-api.js}
|scripts/lib/functions:{args.js,kapso-api.js}
|scripts/lib/workflows:{args.js,kapso-api.js,result.js}
<!-- FILEMAP:END -->

Source

git clone https://github.com/gokapso/agent-skills/blob/master/skills/automate-whatsapp/SKILL.mdView on GitHub

Overview

Automate WhatsApp conversations and event handling using Kapso workflows. Build, edit, and runWhatsApp automations with graph-based workflows, trigger management, execution monitoring, and function deployments, while storing state using integrated databases.

How This Skill Works

Kapso workflows model WhatsApp automation as graphs. You configure WhatsApp triggers, edit and validate the workflow graph, manage executions, and deploy functions, with state stored via app integrations and databases like D1 for persistent data.

When to Use It

  • When you need to create or update a WhatsApp automation workflow from scratch, including triggers, graph structure, and execution paths.
  • When you must edit an existing workflow graph and keep track of lock versions to avoid conflicts.
  • When you want to inspect, debug, and understand executions and their events to diagnose issues.
  • When you need to create and deploy custom functions that respond to WhatsApp events or messages.
  • When you want to integrate WhatsApp automations with external apps, accounts, or databases for state management.

Quick Start

  1. Step 1: Set up environment variables: KAPSO_API_BASE_URL (host only) and KAPSO_API_KEY.
  2. Step 2: Fetch and edit a workflow graph using node scripts/get-graph.js <workflow_id>, then edit and validate with node scripts/validate-graph.js and node scripts/update-graph.js.
  3. Step 3: Create and deploy a function (name and code-file), then verify function deployment and monitor executions.

Best Practices

  • Use the lock_version when editing graphs to prevent merge conflicts and re-fetch after edits.
  • Validate graphs with the provided validator before updating to avoid broken workflows.
  • Test inbound_message triggers by first listing available phone_number_id values.
  • Store essential state in app integrations or a database (e.g., D1) to enable reliable context across executions.
  • Document and version-control graph rules (start node, edge labels, and node IDs) to ensure team consistency.

Example Use Cases

  • Welcome new users with a guided WhatsApp onboarding flow triggered on user opt-in.
  • Provide order status updates by routing customer messages through a status workflow with dynamic data.
  • Send appointment reminders and follow-ups using time-based triggers and context-aware messages.
  • Route support inquiries to the appropriate agent or function using inbound_message triggers and context variables.
  • Notify customers about stock changes or promotions by integrating WhatsApp with external inventory or marketing systems.

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers