Microsoft Bot Framework Connector

[#1]

Note on third‑party tools

We aim to provide accurate and helpful details about third‑party tools, but we can’t guarantee that this information is always complete or up to date. If you notice any discrepancies, feel free to share them in the feedback section below. For the most reliable information, please always refer to the third‑party tool’s official documentation.

Manage conversational interactions across platforms using Microsoft Bot Framework

Connections

OAuth 2.0 Client Credentials

OAuth 2.0 Client Credentials Connectivity for Microsoft Bot Framework

The Microsoft Bot Framework component authenticates using OAuth 2.0 Client Credentials associated with your Azure Bot's App Registration.

To begin you will need to create a new Azure Bot or retrieve the app id and app password (client secret) for an existing bot. If creating a new bot you will likely want to set its type to "Multi Tenant" to allow using your bot across tenants.

Open the Azure Bot and ensure that appropriate Channels are enabled and configured for your intended use case. Each will require additional configuration - Microsoft Teams, for example, will require a Teams app containing a manifest file specifying your bot's configuration with Teams.

Next, navigate to the "Configuration" blade of the bot and click "Manage" next to "Microsoft App ID". This will take you to the Azure AD App Registration for the bot. From here you are able to create a new Client Secret from the "Certificates & Secrets" blade. This will be your "Client secret" (some Microsoft documentation also refers to this as the "app password").

The Client ID and Tenant ID (for Single Tenant bots) can be retrieved from the "Overview" blade.

Next supply the following values to the OAuth 2.0 Client Credentials connection in your flow:

• For Client ID enter the value for "Microsoft App ID" or the "Client ID" from the app registration.
• For Client Secret enter the value from "Certificates & Secrets" of the app registration.
• If your bot is configured as "Single Tenant" you will need to use the conventional Token URL for Azure: https://login.microsoftonline.com/tenantId/oauth2/v2.0/token and replace tenantId with the ID of your tenant.

This connection uses OAuth 2.0, a common authentication mechanism for integrations.
Read about how OAuth 2.0 works here.

Input	Comments	Default
Token URL	The OAuth 2.0 Token URL for Microsoft Bot Framework. Use the default for Multi-Tenant bots and https://login.microsoftonline.com/<tenant id>/oauth2/v2.0/token for Single-Tenant.	https://login.microsoftonline.com/botframework.com/oauth2/v2.0/token
Client ID
Client secret value

Triggers

Bot Framework Trigger

Trigger that validates incoming requests as coming from Bot Framework

Input	Comments	Default
Microsoft App ID	Microsoft App ID found in the Azure Bot's Configuration blade.

Actions

Create Conversation

Create a new Conversation

Input	Comments	Default
Connection
Service URL	The Service URL (also referred to as Base URI) to send requests to the Bot Framework. Varies per bot channel and region.
API Version	Version of the API to call	3
Bot ID	Identifier of the Bot receiving requests
Channel Account ID	Identifier of the Channel Account to use (refers to conversation members; bots and users)
Tenant ID	Tenant ID of the Channel Account ID

Get Conversation Members

Get list of members of the conversation

Input	Comments	Default
Connection
Service URL	The Service URL (also referred to as Base URI) to send requests to the Bot Framework. Varies per bot channel and region.
API Version	Version of the API to call	3
Conversation ID	Identifier of the Conversation to use (refers to a channel, team, direct message)

Raw Request

Issue a raw HTTP request

Input	Comments	Default
Connection
URL	This is the URL to call.
Method	The HTTP method to use.
Data	The HTTP body payload to send to the URL.
Form Data	The Form Data to be sent as a multipart form upload.
File Data	File Data to be sent as a multipart form upload.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Header	A list of headers to send with the request.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Timeout	The maximum time that a client will await a response to its request
Debug Request	Enabling this flag will log out the current request.	false
Retry Delay (ms)	The delay in milliseconds between retries.	0
Retry On All Errors	If true, retries on all erroneous responses regardless of type.	false
Max Retry Count	The maximum number of retries to attempt.	0
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries.	false

Send Adaptive Card Message

Send an adaptive card message

Input	Comments	Default
Connection
Service URL	The Service URL (also referred to as Base URI) to send requests to the Bot Framework. Varies per bot channel and region.
API Version	Version of the API to call	3
Conversation ID	Identifier of the Conversation to use (refers to a channel, team, direct message)
Card Payload	Adaptive Card payload to send

Send Message

Create a message to a Conversation

Input	Comments	Default
Connection
Service URL	The Service URL (also referred to as Base URI) to send requests to the Bot Framework. Varies per bot channel and region.
API Version	Version of the API to call	3
Conversation ID	Identifier of the Conversation to use (refers to a channel, team, direct message)
Text	Text of the message to send
Text Format	Text Format of the message to send	markdown