plugin.yaml 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. name: whatsapp_cloud-platform
  2. label: WhatsApp Business (Cloud)
  3. kind: platform
  4. version: 1.0.0
  5. description: >
  6. WhatsApp Business Cloud API adapter for Hermes Agent.
  7. Connects to WhatsApp via Meta's official Cloud API (Business account and a
  8. public webhook URL required, token-based auth): Graph API for outbound,
  9. an aiohttp webhook receiver with X-Hub-Signature-256 verification for
  10. inbound. Supports text, media (image/video/audio/document), voice notes,
  11. interactive buttons, and DM allowlists. Complements the Baileys bridge
  12. (whatsapp) plugin; both share WhatsAppBehaviorMixin.
  13. author: NousResearch
  14. requires_env:
  15. - name: WHATSAPP_CLOUD_PHONE_NUMBER_ID
  16. description: "WhatsApp phone number ID from the Meta App Dashboard (WhatsApp → API Setup)"
  17. prompt: "WhatsApp Cloud phone number ID"
  18. password: false
  19. - name: WHATSAPP_CLOUD_ACCESS_TOKEN
  20. description: "System User permanent access token"
  21. prompt: "WhatsApp Cloud access token"
  22. password: true
  23. optional_env:
  24. - name: WHATSAPP_CLOUD_APP_SECRET
  25. description: "App secret — HMAC key for X-Hub-Signature-256 webhook verification"
  26. prompt: "WhatsApp Cloud app secret"
  27. password: true
  28. - name: WHATSAPP_CLOUD_VERIFY_TOKEN
  29. description: "Shared secret for the webhook verification handshake (hub.verify_token)"
  30. prompt: "WhatsApp Cloud verify token"
  31. password: true
  32. - name: WHATSAPP_CLOUD_APP_ID
  33. description: "Meta app ID (optional)"
  34. prompt: "WhatsApp Cloud app ID"
  35. password: false
  36. - name: WHATSAPP_CLOUD_WABA_ID
  37. description: "WhatsApp Business Account ID; when set, inbound webhooks must match it"
  38. prompt: "WhatsApp Business Account ID"
  39. password: false
  40. - name: WHATSAPP_CLOUD_WEBHOOK_HOST
  41. description: "Webhook bind host (unset = dual-stack all interfaces)"
  42. prompt: "Webhook host"
  43. password: false
  44. - name: WHATSAPP_CLOUD_WEBHOOK_PORT
  45. description: "Webhook bind port (default: 8090)"
  46. prompt: "Webhook port"
  47. password: false
  48. - name: WHATSAPP_CLOUD_WEBHOOK_PATH
  49. description: "Webhook path (default: /whatsapp/webhook)"
  50. prompt: "Webhook path"
  51. password: false
  52. - name: WHATSAPP_CLOUD_API_VERSION
  53. description: "Graph API version (default: v20.0)"
  54. prompt: "Graph API version"
  55. password: false
  56. - name: WHATSAPP_CLOUD_ALLOWED_USERS
  57. description: "Comma-separated WhatsApp phone numbers allowed to talk to the bot"
  58. prompt: "Allowed phone numbers (comma-separated)"
  59. password: false
  60. - name: WHATSAPP_CLOUD_ALLOW_ALL_USERS
  61. description: "Allow any WhatsApp user to trigger the bot (dev only)"
  62. prompt: "Allow all users? (true/false)"
  63. password: false
  64. - name: WHATSAPP_CLOUD_DM_POLICY
  65. description: "DM policy: open | allowlist | disabled (falls back to WHATSAPP_DM_POLICY)"
  66. prompt: "DM policy"
  67. password: false
  68. - name: WHATSAPP_CLOUD_HOME_CHANNEL
  69. description: "Default phone number for cron / notification delivery"
  70. prompt: "Home channel phone number"
  71. password: false