@orchesty/connector-discord
v2.0.0
Published
[](https://www.npmjs.com/package/@orchesty/connector-discord) [](https://github.com/Orchesty/orchesty-nodejs-co
Readme
Discord Connector
An Orchesty connector for Discord, an all-in-one voice and text chat platform widely used by communities and teams.
Application Type
Basic (Discord Bot token)
This connector authenticates using a Discord Bot token sent as Bot {token} in the Authorization header. The application also requires the Client ID to generate the bot invite URL.
| Field | Description |
|---|---|
| token | Your Discord Bot token |
| client_id | Your Discord application Client ID (used to generate the bot invite URL) |
Components
| Class | Type | Description |
|---|---|---|
| DiscordSendMessageConnector | Connector | Sends a rich embed message (title, description, color, image) to a channel via POST /api/channels/{channelId}/messages |
Setup
Credentials
- Go to the Discord Developer Portal and create a new application.
- Navigate to Bot and click Add Bot.
- Under the Token section, click Reset Token and copy the token.
- Note your Application ID (Client ID) from the General Information tab.
- In Orchesty, open the Discord application settings and fill in:
- Bot token — paste your Bot token
- Client id — paste your Application ID
- After saving, Orchesty will generate a bot invite URL — use it to add the bot to your Discord server.
API Documentation
Discord API Reference: https://discord.com/developers/docs/reference
Installation & Usage
Install the package:
npm install @orchesty/connector-discord @orchesty/nodejs-sdk
# or
pnpm add @orchesty/connector-discord @orchesty/nodejs-sdkRegister the application and nodes in your Orchesty DI container:
import { container } from '@orchesty/nodejs-sdk';
import DiscordApplication from '@orchesty/connector-discord/dist/DiscordApplication';
import DiscordSendMessageConnector from '@orchesty/connector-discord/dist/Connector/DiscordSendMessageConnector';
const app = new DiscordApplication();
container.setApplication(app);
container.setNode(new DiscordSendMessageConnector(), app);License
This connector is released under the Apache License 2.0. See the LICENSE file for the full license text.
Contributing
Contributions are welcome! This connector is part of the open-source Orchesty Node.js Connectors monorepo.
For guidelines on how to create or update connectors — including project setup, coding conventions, and how to write tests — please refer to the Contributing to Connectors guide.
All contributions should include:
- Source code in
src/following the existing connector structure - Tests in
src/**/__tests__/withinput.json,mock.json, andoutput.jsonfixtures - An updated
CHANGELOG.mdentry
