-
Notifications
You must be signed in to change notification settings - Fork 758
Getting Started
Here are the general steps required to get the emulator and your bot communicating:
- Enter your bot's endpoint into the emulator's address bar. This value differs by hosting environment. See sections below for specific scenarios.
- If your bot is running with Microsoft Account (MSA) credentials, enter these credentials too.
- If your bot is hosted remotely, ensure that
ngroktunneling software is installed and configured. The Bot Framework Emulator is tightly integrated with ngrok and can launch it for you when needed. Learn more about what ngrok is, how the emulator utilizes ngrok, and how to configure it: Tunneling (ngrok). - If you prefer to use alternate tunneling software, you may configure a custom
Callback URLin the emulator's App Settings dialog.
When developing a bot using the BotBuilder SDK, the default endpoint for local debugging is http://localhost:3978/api/messages. This is where the bot will be listening for messages when hosted locally.
For localhost debugging you will not typically need to enter MSA appId or password, although it is supported if your bot requires it.
To connect, enter your bot's endpoint into the address bar and click on the Connect button:
[screenshot]
This scenario is similar to the localhost scenario, but with two new requirements:
- You will need to enter your bot's MSA appId and password.
- You must run tunneling software so that the remotely hosted bot can reply to you. Read up on network tunnel configuration: Tunneling (ngrok)
[screenshot]
If you have registered your bot with the Bot Framework, you can retrieve its endpoint and appId from its registration page. If you do not already know the MSA password of your bot, a new one can be generated from the registration page.
This scenario is similar the remotely hosted scenario, but there are extra steps involved in discovering your bot's endpoint value.
[screenshot]
TODO