Skip to content

docs(apps): note Socket Mode availability on Canary and Pilot1 #693

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
teddy arida-moody (teddyam) merged 1 commit into from
Oct 7, 2026
Merged

docs(apps): note Socket Mode availability on Canary and Pilot1 #693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion samples/SocketModeBot/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);
builder.Services.AddTeamsBotApplication(options => options.UseSocketMode(socket =>
{
// Socket Mode is only available on the canary ring for now.
// Socket Mode is only available on the Canary and Pilot1 rings for now.
// Pilot1 (https://pilot1.botapi.skype.com) is supported as well.
socket.NegotiateBaseUrl = new Uri("https://canary.botapi.skype.com");
}));
IHost host = builder.Build();
Expand Down
2 changes: 1 addition & 1 deletion samples/SocketModeBot/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This sample is an echo bot that receives activities over Socket Mode instead of

## What it shows

- `UseSocketMode(...)` on `AddTeamsBotApplication` to receive activities over Socket Mode, with `NegotiateBaseUrl` set to the canary ring, the only ring where Socket Mode is available today.
- `UseSocketMode(...)` on `AddTeamsBotApplication` to receive activities over Socket Mode, with `NegotiateBaseUrl` set to the canary ring. Socket Mode is currently only available on the Canary (`https://canary.botapi.skype.com`) and Pilot1 (`https://pilot1.botapi.skype.com`) rings.
- `<NoWarn>$(NoWarn);ExperimentalTeamsSocketMode</NoWarn>` in the project file, because Socket Mode is experimental.
- A generic host (`Host.CreateApplicationBuilder`) with no web server, and `UseTeamsBotApplication()` to get the app.

Expand Down
5 changes: 3 additions & 2 deletions src/Microsoft.Teams.Apps/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,8 +166,9 @@ host.Run();
- **Public cloud only** &mdash; Registration fails for bots configured for another cloud.
- **Classic bot identity only** &mdash; The connection is negotiated with the bot's app ID and credentials. Agentic
identities are not supported.
- **Canary endpoint** &mdash; Socket Mode is currently available only on the canary ring. Set `NegotiateBaseUrl` to
`https://canary.botapi.skype.com` until it is enabled on the default production endpoint.
- **Canary and Pilot1 endpoints** &mdash; Socket Mode is currently available only on the Canary and Pilot1 rings. Set
`NegotiateBaseUrl` to `https://canary.botapi.skype.com` or `https://pilot1.botapi.skype.com` until it is enabled on
the default production endpoint.
- **Rejected credentials are not retried** &mdash; If negotiation returns HTTP 401 or 403, startup fails immediately.
After startup, the affected geo stops reconnecting until the app restarts.
- **Idempotent handlers** &mdash; The service can redeliver an activity, for example after a reconnect, so handlers
Expand Down
Loading