Compartilhar via

AtBot Logic

  • Reference

AtBot is a no-code bot building service that allows you to create conversational UIs quickly without any programming experience.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Standard All Power Automate regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Standard All Power Apps regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name AtBot Support
URL https://admin.atbot.io/Docs
Email support@atbot.io
Connector Metadata
Publisher H3 Solutions Inc.
Website https://www.atbot.io
Privacy policy https://admin.atbot.io/privacy
Categories AI;Productivity

The AtBot Logic connector is used to create bot skills for bots built in the AtBot service. Using the actions in the connector, you can create complex conversational skills for your bots and connect them to other services by using additional connectors. AtBot is free to try in Microsoft Teams, with a premium version available to build custom bots on additional platforms. Visit the AtBot website for more information.

Prerequisites

In order to use the free version of AtBot, you must have a Microsoft Teams account and have downloaded the AtBot bot from the app store.

To use the premium version where you can build your own custom bots, you must sign up for AtBot Premium. When you sign up for Premium, you will be give $25 credit to try out the service.

How to get credentials

You will always log in to the AtBot connector using an Microsoft Entra ID Work or School account.

Known issues and limitations

We have depricated the LUIS support in the keyword trigger. Please use LUIS Intent Vectors to create skills that recognize natural language.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Delete from bot memory

This operation is used to remove a piece of information from memory in the bot.
Generate Adaptive Card

This operation is used to a generate an adaptive card to be used later to display a list or carousel of cards.
Get adaptive card response from User

This operation is used to ask the user for input via adaptive card.
Get Bot Memory Items by Type

Get all Bot Memory Items by Type.
Get choice list response from User

This operation is used to ask the user for choice list input.
Get choice response from User

This operation is used to ask the user for choice input.
Get datetime response from User

This operation is used to ask the user for datetime input.
Get intent vector response from User

This operation is used to ask the user for NLP input.
Get memory response from User

This operation is used to ask the user for bot memory input.
Get people response from User

This operation is used to ask the user for people picker input.
Get response from User

This operation is used to ask the user for input.
Register chat bridge between two or more conversations

This operation is used to initiate a chat bridge between two or more users.
Save to bot memory

This operation is used to save a piece of information to memory in the bot.
Send Adaptive Card reply

This operation is used to a send an adaptive card reply to the activity that triggered the flow.
Send Adaptive Card Set reply

This operation is used to a send an adaptive card set reply to the activity that triggered the flow. The set can be in either List or Carousel form.
Send Event

This operation is used to a send an event to the bot client.
Send reply

This operation is used to a send a reply to the activity that triggered the flow.
Start a new group conversation

This operation is used to start a new group conversation in a channel.
Start a new private conversation

This operation is used to start a new private conversation with a user.
Update an adaptive card sent to a tab

This operation is used to update a card sent to a tab.

Delete from bot memory

Operation ID:
DeleteBotMemory

This operation is used to remove a piece of information from memory in the bot.

Parameters

Name Key Required Type Description
User Principal Name
 user True string

The user to save the memory item against.
Memory Type
 type True string

The type of memory.
Value
 value True string

The memory item value.

Returns

Body
Response_DeleteBotMemory

Generate Adaptive Card

Operation ID:
GenerateAdaptiveCard

This operation is used to a generate an adaptive card to be used later to display a list or carousel of cards.

Parameters

Name Key Required Type Description
Selected Adaptive Card
 selectedCard True string

Select the adaptive card.
content
 content dynamic

Returns

response
object

Get adaptive card response from User

Operation ID:
WebHookRegistrations_InputResponse_ADAPTIVECARD

This operation is used to ask the user for input via adaptive card.

Parameters

Name Key Required Type Description
Selected Adaptive Card
 selectedCard True string

Select the adaptive card.
webHook
 webHook dynamic

Returns

The outputs of this operation are dynamic.

Get Bot Memory Items by Type

Operation ID:
GetMemoryItemsByType

Get all Bot Memory Items by Type.

Parameters

Name Key Required Type Description
User Principal Name.
 user True string

Provide the User Principal Name.
Memory Type
 type True string

Provide the type of memory to list.

Returns

response
array of MemoryItem

Get choice list response from User

Operation ID:
WebHookRegistrations_InputResponse_CHOICELIST

This operation is used to ask the user for choice list input.

Parameters

Name Key Required Type Description
filters
 filters array of string
headers
 headers object
properties
 properties object
Icon URL
 icon string

Enter an absolute url to an icon to display for each choice item.
Message
 message True string

Enter the message to send to the user.
Choice Values
 choices True object

Provide the choice array object.
Reply Activity
 activityJson True string

Reply Activity from the bot.
Accept Response From
 acceptResponseFrom string

Accept response from specific user or any user.
Allow Branching
 allowBranching string

Allow the user to trigger branching skills before providing a response.
Show in chat
 showInChat boolean

If this is a Teams call, show this message in chat. Otherwise, the bot will only speak the message.
Listen for voice response
 listenForInput boolean

If this is a Teams call, this property determines whether the bot listens for a voice response. If no, or not a Teams call the bot will not immediately listen for a voice response.

Returns

Body
BotResponse_ChoiceList

Get choice response from User

Operation ID:
WebHookRegistrations_InputResponse_CHOICE

This operation is used to ask the user for choice input.

Parameters

Name Key Required Type Description
filters
 filters array of string
headers
 headers object
properties
 properties object
Message
 message True string

Enter the message to send to the user.
Choice Values
 choices True string

Provide each choice on a separate line.
Reply Activity
 activityJson True string

Reply Activity from the bot.
Accept Response From
 acceptResponseFrom string

Accept response from specific user or any user.
Allow Branching
 allowBranching string

Allow the user to trigger branching skills before providing a response.
Show in chat
 showInChat boolean

If this is a Teams call, show this message in chat. Otherwise, the bot will only speak the message.
Listen for voice response
 listenForInput boolean

If this is a Teams call, this property determines whether the bot listens for a voice response. If no, or not a Teams call the bot will not immediately listen for a voice response.

Returns

Body
BotResponse_Choice

Get datetime response from User

Operation ID:
WebHookRegistrations_InputResponse_DATE

This operation is used to ask the user for datetime input.

Parameters

Name Key Required Type Description
filters
 filters array of string
headers
 headers object
properties
 properties object
Date Scope
 dateScope True string

Select the scope of the date value.
Message
 message True string

Enter the message to send to the user.
Reply Activity
 activityJson True string

Reply Activity from the bot.
Accept Response From
 acceptResponseFrom string

Accept response from specific user or any user.
Allow Branching
 allowBranching string

Allow the user to trigger branching skills before providing a response.
Show in chat
 showInChat boolean

If this is a Teams call, show this message in chat. Otherwise, the bot will only speak the message.

Returns

Body
BotResponse_Date

Get intent vector response from User

Operation ID:
WebHookRegistrations_InputResponse_INTENTVECTOR

This operation is used to ask the user for NLP input.

Parameters

Name Key Required Type Description
filters
 filters array of string
headers
 headers object
properties
 properties object
Message
 message True string

Enter the message to send to the user.
LUIS Intent Vector
 intentVector True string

Pick your LUIS Intent Vector.
Reply Activity
 activityJson True string

Reply Activity from the bot.
Accept Response From
 acceptResponseFrom string

Accept response from specific user or any user.
Allow Branching
 allowBranching string

Allow the user to trigger branching skills before providing a response.
Show in chat
 showInChat boolean

If this is a Teams call, show this message in chat. Otherwise, the bot will only speak the message.

Returns

The outputs of this operation are dynamic.

Get memory response from User

Operation ID:
WebHookRegistrations_InputResponse_MEMORY

This operation is used to ask the user for bot memory input.

Parameters

Name Key Required Type Description
filters
 filters array of string
headers
 headers object
properties
 properties object
Message
 message True string

Enter the message to send to the user.
Memory Type
 type True string

Provide the type of memory to list.
Reply Activity
 activityJson True string

Reply Activity from the bot.
Icon URL
 icon string

Enter an absolute url to an icon to display for each choice item.
Accept Response From
 acceptResponseFrom string

Accept response from specific user or any user.
Target User
 targetUserMemory string

Optionally specify the UPN of the user the bot should pull memory items from. If left blank, it will pull memory items from the user that initiated the skill. In the case of a group conversation started from the bot, it will pull memory items from the user authenticated in Flow.
Allow Branching
 allowBranching string

Allow the user to trigger branching skills before providing a response.
Show in chat
 showInChat boolean

If this is a Teams call, show this message in chat. Otherwise, the bot will only speak the message.

Returns

Body
BotResponse_Memory

Get people response from User

Operation ID:
WebHookRegistrations_InputResponse_PEOPLE

This operation is used to ask the user for people picker input.

Parameters

Name Key Required Type Description
filters
 filters array of string
headers
 headers object
properties
 properties object
Message
 message True string

Enter the message to send to the user.
Mode
 mode True string

Ask the user to select one or many people.
Search String
 searchstr string

Optionally provide a starting search string.
Reply Activity
 activityJson True string

Reply Activity from the bot.
Accept Response From
 acceptResponseFrom string

Accept response from specific user or any user.
Allow Branching
 allowBranching string

Allow the user to trigger branching skills before providing a response.
Show in chat
 showInChat boolean

If this is a Teams call, show this message in chat. Otherwise, the bot will only speak the message.
Listen for voice response
 listenForInput boolean

If this is a Teams call, this property determines whether the bot listens for a voice response. If no, or not a Teams call the bot will not immediately listen for a voice response.

Returns

Body
BotResponse_People

Get response from User

Operation ID:
WebHookRegistrations_InputResponse

This operation is used to ask the user for input.

Parameters

Name Key Required Type Description
filters
 filters array of string
headers
 headers object
properties
 properties object
Message
 message True string

Enter the message to send to the user.
Reply Activity
 activityJson True string

Reply Activity from the bot.
Accept Response From
 acceptResponseFrom string

Accept response from specific user or any user.
Show in chat
 showInChat boolean

If this is a Teams call, show this message in chat. Otherwise, the bot will only speak the message.

Returns

Body
BotResponse

Register chat bridge between two or more conversations

Operation ID:
WebHookRegistrations_InitiateBridge

This operation is used to initiate a chat bridge between two or more users.

Parameters

Name Key Required Type Description
filters
 filters array of string
headers
 headers object
properties
 properties object
User Name
 chatUserName True string

Display name of the chat user.
Initiation Message
 chatInitiationMessage string

Message to send to this user when the chat bridge is established.
Reply Activity
 activityJson True string

The reply activity for the chat user.
End Chat Command
 endBridgeCommand True string

The keyword command to send to the bot to end the chat bridge.
Idle Timeout
 idleTimeoutDuration True integer

The duration (in minutes) of idle activity to trigger a timeout.

Returns

Body
BridgeOutcome

Save to bot memory

Operation ID:
SaveBotMemory

This operation is used to save a piece of information to memory in the bot.

Parameters

Name Key Required Type Description
User Principal Name
 user True string

The user to save the memory item against.
Memory Type
 type True string

The type of memory.
Title
 title True string

The memory item title.
Value
 value True string

The memory item value.

Returns

Body
Response_SaveBotMemory

Send Adaptive Card reply

Operation ID:
SendReplyWithAdaptiveCard

This operation is used to a send an adaptive card reply to the activity that triggered the flow.

Parameters

Name Key Required Type Description
Selected Adaptive Card
 selectedCard True string

Select the adaptive card.
content
 content True dynamic

Returns

Body
BotReplyResponse

Send Adaptive Card Set reply

Operation ID:
SendReplyWithAdaptiveCardSet

This operation is used to a send an adaptive card set reply to the activity that triggered the flow. The set can be in either List or Carousel form.

Parameters

Name Key Required Type Description
Adaptive Card Set
 cards True object

Provide the card set object.
Display Style
 displayStyle True string

Select the display style to use.
Reply Activity
 activityJson True string

Reply Activity from the bot.
Show In Tab
 showInTab boolean

Display this card set in a tab instead of inline chat.
Tab Button Label
 deepLinkButtonLabel string

Button label for displaying in a tab.
Tab Button Message
 deepLinkMessage string

Message to send with the button when displaying in a tab.

Returns

Body
BotReplyResponse

Send Event

Operation ID:
SendBridgeEvent

This operation is used to a send an event to the bot client.

Parameters

Name Key Required Type Description
Reply Activity
 activityJson True string

Reply Activity from the bot
Event JSON
 eventObject True object

The JSON object to be sent in the chat event.

Send reply

Operation ID:
SendReply

This operation is used to a send a reply to the activity that triggered the flow.

Parameters

Name Key Required Type Description
Reply Text
 message True string

The message to reply to the user with.
Reply Activity
 activityJson True string

Reply Activity from the bot
Show in chat
 showInChat boolean

If this is a Teams call, show this message in chat. Otherwise, the bot will only speak the message.
Custom Channel Data
 customChannelDataJson string

Custom Channel Data Json for the message (only supported in Direct Line)
Signal Response JSON
 signalResponse string

Signal Response JSON string
Message ID
 messageId string

(Optional) ID of a previous message in the same conversation to replace. If supplied, the bot will replace an existing chat message with this message.

Returns

Body
BotReplyResponse

Start a new group conversation

Operation ID:
StartGroupConversation

This operation is used to start a new group conversation in a channel.

Parameters

Name Key Required Type Description
Target Bot
 EnterpriseBot True string

Select the bot.
Channel Listing
 teamIDStr True object

The channel listing output.
Channel Name
 channelId True string

The channel to post the conversation to. Type in the name.
Conversation Text
 message True string

The message to start the conversation with.

Returns

Body
BotGroupConversationStartResponse

Start a new private conversation

Operation ID:
StartConversation

This operation is used to start a new private conversation with a user.

Parameters

Name Key Required Type Description
Target Bot
 EnterpriseBot True string

Select the bot.
Conversation Text
 message True string

The message to start the conversation with.
User
 user True string

User principal name (UPN).

Returns

Body
BotConversationStartResponse

Update an adaptive card sent to a tab

Operation ID:
UpdateAdaptiveCard

This operation is used to update a card sent to a tab.

Parameters

Name Key Required Type Description
Adaptive Card
 card True object

Provide the card to use as the update.
Reply Activity
 activityJson True string

Reply Activity from the bot.

Returns

Body
BotReplyResponse

Triggers

When a keyword is used

This operation triggers when the given keyword(s) are used by the bot. Supply multiple keywords in semi-colon delimited format.
When an intent vector is recognized

This operation triggers when the given LUIS intent vector is recognized by the bot.

When a keyword is used

Operation ID:
WebHookRegistrations_Post

This operation triggers when the given keyword(s) are used by the bot. Supply multiple keywords in semi-colon delimited format.

Parameters

Name Key Required Type Description
filters
 filters array of string
headers
 headers object
properties
 properties object
Trigger Description
 triggerDescription True string

Description shown in the bot help dialog
Bot Trigger Type
 triggerType True string

Select the type of trigger.
Keywords
 keywords string

Enter custom keywords that will trigger the Flow.
(Deprecated) LUIS API Key
 luisApiKey string

(Deprecated) Provide AtBot with your LUIS API Key. This parameter is deprecated. Please use the Intent Vector trigger for LUIS use going forward.
(Deprecated) LUIS App
 luisAppId string

(Deprecated) Pick your LUIS app. This parameter is deprecated. Please use the Intent Vector trigger for LUIS use going forward.
(Deprecated) LUIS Intent
 luisIntent string

(Deprecated) Pick the LUIS intent to use. This parameter is deprecated. Please use the Intent Vector trigger for LUIS use going forward.

Returns

The outputs of this operation are dynamic.

When an intent vector is recognized

Operation ID:
WebHookRegistrationsVector_Post

This operation triggers when the given LUIS intent vector is recognized by the bot.

Parameters

Name Key Required Type Description
filters
 filters array of string
headers
 headers object
properties
 properties object
Trigger Description
 triggerDescription True string

Description shown in the bot help dialog.
Bot Trigger Type
 triggerType True string

Select the type of trigger.
LUIS Intent Vector
 intentVector string

Pick your LUIS Intent Vector.
Allow Branching
 allowBranching string

Allow the user to trigger branching skills while answering followup questions.

Returns

The outputs of this operation are dynamic.

Definitions

BotReplyResponse

Name Path Type Description
Message Id
 id string

Id of the message created from the reply. Used to update the message.

BotResponse

Name Path Type Description
Response Text
 text string

The response the user entered.
Cancellation Notice
 cancelNotice boolean

This flag will be True if the user responds with a cancellation keyword.
Responding User
 respondingUser string

The user responding to the bot.
files
 files array of object
File Name
 files.name string

The file name.
File Type
 files.content-type string

The file type.
File Bytes
 files.bytes byte

The file bytes.

BotResponse_Date

Name Path Type Description
Response Date
 text date-time

The response datetime the user entered.
Response Date UTC
 text_UTC date-time

The response datetime the user entered, in UTC format.
Cancellation Notice
 cancelNotice boolean

This flag will be True if the user responds with a cancellation keyword.
Responding User
 respondingUser string

The user responding to the bot.

BotResponse_Choice

Name Path Type Description
Response Choice
 text string

The response choice the user entered.
Cancellation Notice
 cancelNotice boolean

This flag will be True if the user responds with a cancellation keyword.
Responding User
 respondingUser string

The user responding to the bot.

BotResponse_ChoiceList

Name Path Type Description
Selected Choice List Title
 title string

The selected choice list title.
Selected Choice List Subtitle
 subtitle string

The selected choice list subtitle.
Selected Choice List Value
 value string

The selected choice list value.
Cancellation Notice
 cancelNotice boolean

This flag will be True if the user responds with a cancellation keyword.
Responding User
 respondingUser string

The user responding to the bot.

BotResponse_People

Name Path Type Description
people
 people array of object
User Principal Name
 people.upn string

The user principal name.
User Id
 people.userid string

The user Id.
Full Name
 people.fullname string

The user full name.
Email
 people.email string

The user email.
Cancellation Notice
 cancelNotice boolean

This flag will be True if the user responds with a cancellation keyword.
Responding User
 respondingUser string

The user responding to the bot.

BotResponse_Memory

Name Path Type Description
Memory Item Title
 title string

The title of the memory item.
Memory Item Value
 value string

The value of the memory item.
Cancellation Notice
 cancelNotice boolean

This flag will be True if the user responds with a cancellation keyword.
Responding User
 respondingUser string

The user responding to the bot.

Response_SaveBotMemory

Name Path Type Description
Bot Memory Save Result
 text string

The result of the save to bot memory.

Response_DeleteBotMemory

Name Path Type Description
Bot Memory Delete Result
 text string

The result of the delete from bot memory.

BotGroupConversationStartResponse

Name Path Type Description
Conversation Id
 id string

Id of the conversation created from the start group conversation. Used to update the conversation.
Message Id
 messageId string

Id of the message created from the start group conversation. Used to update the message.
Reply Activity
 activityJson string

Activity Json.

BotConversationStartResponse

Name Path Type Description
Message Id
 id string

Id of the message created from the reply. Used to update the message.
Reply Activity
 activityJson string

Activity Json.

BridgeOutcome

Name Path Type Description
Outcome
 outcome string

The outcome of the bridge.
Bridge Closed By
 bridgeClosedBy string

The user that closed the bridge.

MemoryItem

Name Path Type Description
Memory Item Title
 title string

The title of the memory item.
Memory Item Value
 value string

The value of the memory item.

object

This is the type 'object'.