Connectors API

The connectors API manages the agent's platform connector configurations. Connectors bridge the agent to external messaging platforms. 28 connectors are supported: Discord, Telegram, Slack, WhatsApp, Signal, iMessage, Blooio, MS Teams, Google Chat, Twitter, Farcaster, Twitch, Mattermost, WeChat, Matrix, Feishu, Nostr, Lens, BlueBubbles, Bluesky, Instagram, LINE, Zalo, Twilio, GitHub, Gmail Watch, Nextcloud Talk, and Tlon. Configuration is persisted to the Eliza config file. Changes typically require a restart to take effect.

See the Connectors guide for detailed setup instructions per platform.

Endpoints

GET /api/connectors

Returns all configured connectors with secrets redacted.

Response

{
  "connectors": {
    "telegram": {
      "botToken": "****:****"
    },
    "discord": {
      "token": "****"
    }
  }
}

POST /api/connectors

Add a new connector or update an existing one. The connector config is saved to the Eliza config file.

Request Body

{
  "name": "telegram",
  "config": {
    "botToken": "123456:ABC-DEF..."
  }
}

Response

Returns the updated connectors map (with secrets redacted):

{
  "connectors": {
    "telegram": {
      "botToken": "****:****"
    }
  }
}

Errors

DELETE /api/connectors/:name

Remove a connector from the configuration. Also removes from the legacy channels config key if present.

Path Parameters

Response

Returns the updated connectors map:

{
  "connectors": {}
}

Errors