Configure your Bot for BDK 1.0

Bot Configuration guide for using the BDK and CLI Tool

Configure your Bot for BDK

This page is a configuration guide specific to using the Symphony BDK and the BDK CLI Tool.


  • Node.JS

  • Java 8

  • Maven 3

  • Git

Install the BDK CLI

$ npm install -g symphony-bdk-cli

Confirm all the dependencies are met:

$ symphony-bdk-cli --check-dependencies

1. Generate your Bot

To generate a new bot project, enter the following:

$ symphony-bdk-cli --bot

This will prompt with you a number of questions about your bot and Pod configuration. Type in your bot's metadata, use arrows to scroll, and press enter to move on to the next prompt:

✔ All Dependencies are met!
Setting up a new Bot application
Please answer the following questions
? What's the bot project name? (required) demo-bot2
? What's the bot username? (required) demobot2
? What's the bot email address? (required) [email protected]
? What's the base package? (required) com.symphony.documentation
? do you have an existing extension app?, if so what is the application ID declared in Symphony?
? Please Provide the Symphony Pod address this bot will serve
⠋ Generating bot RSA keys
Generating RSA private key, 4096 bit long modulus
✔ Keys generated.
✔ Ran install dependencies
Project ready DONE
Please find below the bot public key, it must be added to the bot user account
please visit: to learn more.
-----END PUBLIC KEY-----

Leave the answer to the application ID question blank and press enter to skip

Upon completion, the BDK CLI tool has created a public/private RSA key pair, a configuration and requirements file, as well as some default commands/datafeed event listeners.

2. Configure your Bot

Once you have your generated bot scaffold, the next step is to configure your bot user.

Ensure that your pod admin has created a corresponding service account on the admin portal of your Symphony Pod. Additionally, you must upload the generated RSA public key for the service account created.

Copy the entire contents of this RSA public key including the dashes on either side, and hand it to your pod admin and request for it to be saved against the respective service account you will be using.

Note: The bot username and bot email address entered to the CLI tool must match exactly the Basic Information shown in the Pod above.

Open your generated bot code in your favorite Java IDE and navigate to the bot-config.json file:

"sessionAuthHost": "",
"sessionAuthPort": 443,
"keyAuthHost": "",
"keyAuthPort": 443,
"podHost": "",
"podPort": 443,
"agentHost": "",
"agentPort": 443,
"appId": "",
"appPrivateKeyPath": "certs/",
"appPrivateKeyName": "demobot2_privatekey.pkcs8",
"botPrivateKeyPath": "certs/",
"botPrivateKeyName": "demobot2_privatekey.pkcs8",
"botUsername": "demobot2",
"authTokenRefreshPeriod": "30",
"authenticationFilterUrlPattern": "/secure/",
"showFirehoseErrors": false,
"connectionTimeout": 45000,
"botEmailAddress": "[email protected]"

Confirm that the sessionAuthHost, keyAuthHost, and agentHost matches the correct Pod, Key Manager, and Agent endpoints respectfully. Again, confirm that the botUsername, and botEmailAddress matches the information entered in the admin portal on the Pod.

3. Build Your Bot

Now that you have generated and configured your Bot, move onto one of our BDK tutorials: