meta-business-agent

n8n community node for Meta's Business Agent API (WhatsApp v2): configure and operate skills, business info, FAQ, settings, agent test, and thread control.

Package Information

Released: 2 mo ago
Downloads: 0 weekly / 0 monthly
Latest Version: 0.1.0

Documentation

n8n-nodes-meta-business-agent

npm version
license
n8n community node

An n8n community node for Meta's Business Agent API (WhatsApp v2) — configure and operate an AI-powered WhatsApp Business Agent directly from your n8n workflows: manage skills, business info, FAQs, settings, run onboarding/eligibility checks, test the agent, and release thread control back to your own systems.

⚠️ Experimental notice

The Meta Business Agent API is capability- and region-gated by Meta, and access is rolled out progressively per WhatsApp Business Account. This node has been built to faithfully mirror the documented API contract (the same contract validated in the companion Dify plugin), but it has not been verified end-to-end against a live, fully-enabled Business Agent account. Test carefully in a non-production workflow before relying on it.

Features

This node exposes 6 resources and 13 operations:

  • Agent
    • Check Eligibility — check whether the WhatsApp Business Account is eligible for a Business Agent
    • Start Onboarding — kick off onboarding for a channel (defaults to whatsapp)
    • Run Test — send a test message to the agent and get its reply
  • Skill
    • Create — add a new skill (instruction) to the agent
    • Get Many — list configured skills (optionally filtered by agent ID)
    • Update — update an existing skill
    • Delete — remove a skill
  • Business Info
    • Get — read the configured business info
    • Update — update business description and contact info (email, hours of operation, address)
  • FAQ
    • Create — add a question/answer pair to the agent's FAQ
  • Setting
    • Get — read the agent's settings
    • Update — update rollout, handoff, follow-up, and AI audience settings
  • Thread Control
    • Release — release conversation control from the Business Agent back to your own system

Installation

Option 1 — n8n GUI (recommended)

  1. Go to Settings → Community Nodes.
  2. Select Install.
  3. Enter n8n-nodes-meta-business-agent.
  4. Agree to the risk disclaimer and select Install.

Option 2 — Manual (npm)

npm install n8n-nodes-meta-business-agent

See the n8n community nodes installation guide for self-hosted setup details.

Credentials

This node authenticates using a Meta Business Agent API credential, sent as a bearer token plus an API version header on every request.

Field Description
Access Token A Meta system-user access token with the business_management, whatsapp_business_management, and whatsapp_business_messaging scopes
WhatsApp Phone Number ID The WhatsApp Business phone number ID that every API call is scoped to
API Version 2.0.0 (Meta Business Agent) or 1.0.0 (Legacy Pilot)

To obtain an access token and phone number ID:

  1. Create (or use an existing) Meta app in the Meta for Developers console, linked to a WhatsApp Business Account.
  2. Generate a system-user access token with the scopes listed above.
  3. Copy the phone number ID from WhatsApp → API Setup in the Meta for Developers console.

Operations

Resource Operation Description
Agent Check Eligibility Checks whether the account is eligible for a Business Agent
Agent Start Onboarding Starts onboarding for a channel
Agent Run Test Sends a test message to the agent
Skill Create Creates a new skill
Skill Get Many Lists skills
Skill Update Updates a skill
Skill Delete Deletes a skill
Business Info Get Reads business info
Business Info Update Updates business info and contact details
FAQ Create Adds a question/answer pair
Setting Get Reads agent settings
Setting Update Updates rollout, handoff, follow-up, and AI audience settings
Thread Control Release Releases thread control back to your own system

Example: create a skill

  1. Add a Meta Business Agent node to your workflow.
  2. Select credentials of type Meta Business Agent API.
  3. Set Resource to Skill and Operation to Create.
  4. Fill in the Skill field with the instruction text (for example, "Answer questions about our return policy using the FAQ.").
  5. Optionally expand Additional Fields to set a Title and Description.
  6. Execute the node to create the skill on your Business Agent.

Compatibility

  • Requires n8n version with community package support (v1.x or later).
  • Requires Node.js 20 or later (matches n8n's own runtime requirement).

Resources

Disclaimer

This is an independent, community-maintained project and is not affiliated with, endorsed by, or sponsored by Meta. "Meta", "WhatsApp", and related marks are trademarks of Meta Platforms, Inc. The integration is experimental — review Meta's API terms and your account's rollout status before using it in production.

License

MIT

Discussion