Back to Eliza

BlueBubbles Plugin

packages/docs/plugin-registry/platform/bluebubbles.md

2.0.11.5 KB
Original Source

iMessage connector via a local BlueBubbles server.

Package: @elizaos/plugin-bluebubbles

Auto-Enable

This plugin auto-enables when both serverUrl and password are set in the connector config. No manual install is required.

Auto-Enable

This plugin auto-enables when the BLUEBUBBLES_SERVER_URL environment variable is set.

Configuration

VariableRequiredDescription
BLUEBUBBLES_SERVER_URLYesBlueBubbles server URL
BLUEBUBBLES_PASSWORDYesServer password
BLUEBUBBLES_ENABLEDNoEnable or disable the connector
BLUEBUBBLES_DM_POLICYNoDM policy (e.g., allow, deny, allowlist)
BLUEBUBBLES_ALLOW_FROMNoComma-separated allowed user list
BLUEBUBBLES_GROUP_POLICYNoGroup message policy
BLUEBUBBLES_WEBHOOK_PATHNoWebhook endpoint path
BLUEBUBBLES_GROUP_ALLOW_FROMNoComma-separated allowed group list
BLUEBUBBLES_SEND_READ_RECEIPTSNoSend read receipts for received messages

Features

  • Send and receive iMessage via BlueBubbles HTTP API
  • DM and group chat support
  • Read receipts
  • Webhook-based inbound messages
  • Network-accessible (not limited to the Mac running Messages)