Microsoft Kaizala (Preview)

Microsoft Kaizala is a mobile app that helps you connect with your entire mobile workforce and supply chain, organize and allocate tasks more efficiently with built-in and custom Actions, and get actionable information and insights to accelerate decision-making.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Power Automate Standard All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Power Apps Standard All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Contact
Name Microsoft
URL Microsoft LogicApps Support
Microsoft Power Automate Support
Microsoft Power Apps Support
Connector Metadata
Publisher Microsoft

Throttling Limits

Name Calls Renewal Period
API calls per connection50060 seconds

Actions

Add an existing group as subgroup

This operation allows you to add an existing group as subgroup to another group.

Add subscriber to group

This operation allows you to add subscribers to a group.

Add user to group

This operation allows you to add a user to a group.

Create a group

This operation allows you to create a Kaizala group.

Create a subgroup

This operation allows creation of a subgroup within a group.

Deletes a webhook

Deletes a webhook

Post like or comment to a message

This operation allows you to post like or comment to a message in a specific Kaizala group that you’re a member of.

Remove a subgroup from group

This operation allows you to remove a subgroup as member of another group.

Remove user from a group

This operation allows you to remove a user from a group.

Send action on a group

This operation allows you to send an Action to a specific Kaizala group that you’re a member of.

Send action on a group

This operation allows you to send an Action to a specific Kaizala group that you’re a member of.

Send action reminder on a group

This operation allows you to send a reminder of an action to a specific Kaizala group that you’re a member of.

Send reply to a message

Send reply to a message.

Send text message to a group

This operation allows you to send a text message to a specific Kaizala group that you’re a member of.

Upload a media file

This operation allows you to upload a media file and generates MediaResource which can be used in other APIs to send data.

Upload media from attachment

This operation allows you to upload the given media from attachment and generates MediaResource which can be used in other APIs to send data.

Upload media from url

This operation allows you to upload the given media from URL and generates MediaResource which can be used in other APIs to send data.

Add an existing group as subgroup

This operation allows you to add an existing group as subgroup to another group.

Parameters

Name Key Required Type Description
Group
groupId True string

Select a Group on which action will be performed.

Sub-group
SubGroups string

Subgroup.

Add subscriber to group

This operation allows you to add subscribers to a group.

Parameters

Name Key Required Type Description
Group
groupId True string

Select a Group on which action will be performed.

Subscribers
subscribers True string

List of mobile numbers (for e.g. +911234567890,+912345678901 which need to be added.)

Add user to group

This operation allows you to add a user to a group.

Parameters

Name Key Required Type Description
Group
groupId True string

Select a Group on which action will be performed.

Members
Members True string

List of mobile numbers (for e.g. +911234567890,+912345678901 which need to be added.)

Create a group

This operation allows you to create a Kaizala group.

Parameters

Name Key Required Type Description
Group Name
Name True string

Name of the group to be created.

Welcome Message
WelcomeMessage True string

Enter a welcome message for the members of a group.

Members
Members string

Add members (for e.g. +911234567890,+916810870005) to the created group.

Group Type
GroupType string

Select the type of group.

Short Description
ShortDescriptionString string

Enter a short description for the group.

Long Description
LongDescriptionString string

Enter a long description for the group.

Returns

Create a subgroup

This operation allows creation of a subgroup within a group.

Parameters

Name Key Required Type Description
Group
groupId True string

Select a Group on which action will be performed.

Group Name
Name True string

Name of the group to be created.

Welcome Message
WelcomeMessage True string

Enter a welcome message for the members of a group.

Members
Members string

Add members (for e.g. +911234567890,+916810870005) to the created group.

Group Type
GroupType string

Select the type of group.

Short Description
ShortDescriptionString string

Enter a short description for the group.

Long Description
LongDescriptionString string

Enter a long description for the group.

Deletes a webhook

Deletes a webhook

Parameters

Name Key Required Type Description
Delete Webhook Subscription.
webhookId True string

Delete Webhook Subscription.

Returns

Post like or comment to a message

This operation allows you to post like or comment to a message in a specific Kaizala group that you’re a member of.

Parameters

Name Key Required Type Description
Group
groupId True string

Select a Group on which action will be performed.

Source Group Id
SourceGroupId string

Source Group

Message Id
ReferenceId string

Message Id

Reaction Type
ReactionType string

Reaction Type

Comment
Comment string

Enter the comment you want to post

Returns

Remove a subgroup from group

This operation allows you to remove a subgroup as member of another group.

Parameters

Name Key Required Type Description
Group
groupId True string

Select a Group on which action will be performed.

Sub-group Identifier
subGroupId True string

Enter an identifier for the sub-group.

Remove user from a group

This operation allows you to remove a user from a group.

Parameters

Name Key Required Type Description
Group
groupId True string

Select a Group on which action will be performed.

Select a member
memberId True string

The id of the member

Send action on a group

This operation allows you to send an Action to a specific Kaizala group that you’re a member of.

Parameters

Name Key Required Type Description
Group
groupId True string

Select a Group on which action will be performed.

Action
actionType string

Select Action type.

Action Package
id string

Select an action package.

request
request True dynamic

Send Action Request.

Send to all Subscribers
sendToAll string

Select option

Returns

Send action on a group

This operation allows you to send an Action to a specific Kaizala group that you’re a member of.

Parameters

Name Key Required Type Description
Group
groupId True string

Select a Group on which action will be performed.

Action
actionType string

Select Action type.

request
request True dynamic

Send Action Request.

Send to all Subscribers
sendToAll string

Select option

Returns

Send action reminder on a group

This operation allows you to send a reminder of an action to a specific Kaizala group that you’re a member of.

Parameters

Name Key Required Type Description
Group
groupId True string

Select a Group on which action will be performed.

Action Types
actionType True string

Select Action type.

request
request dynamic

Send Action Reminder Request.

Send to all Subscribers
sendToAll string

Select option

Returns

Send reply to a message

Send reply to a message.

Parameters

Name Key Required Type Description
Group
groupId True string

Select a Group on which action will be performed.

Message Id
replyToReferenceId True string

Message Id

Message
message True string

Enter the message to be send as a reply.

Returns

Send text message to a group

This operation allows you to send a text message to a specific Kaizala group that you’re a member of.

Parameters

Name Key Required Type Description
Group
groupId True string

Select a Group on which action will be performed.

Message
Message True string

Enter a text message.

Subscribers
subscribers string

Enter Mobile numbers with country code (for e.g. +911234567890,+916810870005)

Send to all Subscribers
sendToAll string

Select option

Returns

Upload a media file

This operation allows you to upload a media file and generates MediaResource which can be used in other APIs to send data.

Parameters

Name Key Required Type Description
File Content
fileContent True file

The media should be in multipart form.

Returns

Upload media from attachment

This operation allows you to upload the given media from attachment and generates MediaResource which can be used in other APIs to send data.

Returns

Upload media from url

This operation allows you to upload the given media from URL and generates MediaResource which can be used in other APIs to send data.

Parameters

Name Key Required Type Description
Media url
mediaUrl True string

Url of the media file.

Returns

Triggers

When a custom action is sent in a group

This operation is triggered when someone creates a custom action on a group.

When a group is added as a member to a group

This operation is triggered when someone adds a subgroup to a group.

When a group is removed as a member to a group

This operation is triggered when someone removes a subgroup from a group.

When a member is added to a group

This operation is triggered when someone adds a member to a group.

When a member is removed from a group

This operation is triggered when someone removes a member from a group.

When a survey is sent in a group

This operation is triggered when a survey is created on a group.

When a text message is sent on a group

This operation is triggered when someone sends a text message on a group.

When an existing group member registers on Kaizala for the first time

This operation is triggered when an existing group member registers on Kaizala. In Kaizala, group admin(s) can add user even if he is not on Kaizala

When someone responds to a custom action

This operation is triggered when someone responds to a custom action posted on a group.

When someone responds to a survey

This operation is triggered when someone responds to an existing survey posted on a group.

When there is an announcement sent in a group

This operation is triggered when someone sends an announcement action to a group.

When there is an attachment sent in a group

This operation is triggered when someone sends an attachment action to a group.

When a custom action is sent in a group

This operation is triggered when someone creates a custom action on a group.

Parameters

Name Key Required Type Description
Group
objectId True string

Select a group.

Action Package
actionPackageId string

Select an action package.

Returns

When a group is added as a member to a group

This operation is triggered when someone adds a subgroup to a group.

Parameters

Name Key Required Type Description
Group
objectId True string

Select a group.

Returns

When a group is removed as a member to a group

This operation is triggered when someone removes a subgroup from a group.

Parameters

Name Key Required Type Description
Group
objectId True string

Select a group.

Returns

When a member is added to a group

This operation is triggered when someone adds a member to a group.

Parameters

Name Key Required Type Description
Group
objectId True string

Select a group.

Returns

When a member is removed from a group

This operation is triggered when someone removes a member from a group.

Parameters

Name Key Required Type Description
Group
objectId True string

Select a group.

Returns

When a survey is sent in a group

This operation is triggered when a survey is created on a group.

Parameters

Name Key Required Type Description
Group
objectId True string

Select a group.

Returns

When a text message is sent on a group

This operation is triggered when someone sends a text message on a group.

Parameters

Name Key Required Type Description
Group
objectId True string

Select a group.

Returns

When an existing group member registers on Kaizala for the first time

This operation is triggered when an existing group member registers on Kaizala. In Kaizala, group admin(s) can add user even if he is not on Kaizala

Parameters

Name Key Required Type Description
Group
objectId True string

Select a group.

Returns

When someone responds to a custom action

This operation is triggered when someone responds to a custom action posted on a group.

Parameters

Name Key Required Type Description
Group
groupId True string

Select a group.

Action Package
actionPackageId True string

Select an action package.

Action
objectId True string

Select a custom action.

Returns

The outputs of this operation are dynamic.

When someone responds to a survey

This operation is triggered when someone responds to an existing survey posted on a group.

Parameters

Name Key Required Type Description
Group
groupId True string

Select a group.

Survey
objectId True string

Select a survey.

Returns

The outputs of this operation are dynamic.

When there is an announcement sent in a group

This operation is triggered when someone sends an announcement action to a group.

Parameters

Name Key Required Type Description
Group
objectId True string

Select a group.

Returns

When there is an attachment sent in a group

This operation is triggered when someone sends an attachment action to a group.

Parameters

Name Key Required Type Description
Group
objectId True string

Select a group.

Returns

Definitions

SendMessageResponse

Name Path Type Description
Message Id
referenceId string

Message Id.

SendActionResponse

Name Path Type Description
Message Id
referenceId string

Message Id.

Action instance Id
actionId string

Action instance Id. It can be used to query responses using Get Action Details.

CreateGroupResponse

Name Path Type Description
Group Id
groupId string

Group identifier of the created group.

UploadMediaResponse

Name Path Type Description
Media Resource
mediaResource string

Media Resource Identifier which can be used to send media (as attachment) to other apis.

PostReactionResponse

Name Path Type Description
Reaction Id
ReactionId string

Reaction Id.

AnnouncementSchema

Name Path Type Description
Description
text string

Description of the announcement

Title
title string

Title of the announcement

Medias
media array of

List of media urls

File Content
mediaContent array of

List of file Contents

Sender Mobile Number
fromUser string

Mobile number of the sender

Sender Name
fromUserName string

Name of the sender

Sender Profile Picture Url
fromUserProfilePic string

Profile picture url of the sender

Source Group Id
groupId string

Source Group Id

Source Group Id
sourceGroupId string

Source Group Id

Message Id
messageId string

Message Id

Creator User Id
fromUserId string

Creator User Id

AttachmentSchema

Name Path Type Description
Caption
caption string

Caption of the attachment

Type
actionType string

Type of the attachment

Medias
media array of

List of media urls

File Content
mediaContent array of

List of file Contents

Sender Mobile Number
fromUser string

Mobile number of the sender

Sender Name
fromUserName string

Name of the sender

Sender Profile Picture Url
fromUserProfilePic string

Profile picture url of the sender

Source Group Id
groupId string

Source Group Id

Source Group Id
sourceGroupId string

Source Group Id

Message Id
messageId string

Message Id

Sender User Id
fromUserId string

Sender User Id

ActionCreatedSchema

Name Path Type Description
Action Title
actionTitle string

Title of the action

Creator Mobile Number
fromUser string

Mobile number of the creator

Creator Name
fromUserName string

Name of the creator

Creator Profile Picture Url
fromUserProfilePic string

Profile picture url of the creator

Group Id
groupId string

Group Id

Action Instance Id
actionId string

Action Instance Id

Creator User Id
fromUserId string

Creator User Id

GroupAddedSchema

Name Path Type Description
Subgroup Identifier
groupId string

Identifier of the subgroup

Subgroup Name
groupName string

Name of the subgroup

Subgroup Picture Url
groupPicUrl string

Picture url of the subgroup

Subgroup Type
groupType string

Type of the subgroup

Added By
fromUser string

Mobile number of the person

Added By
fromUserName string

Name of the person

Creator Profile Picture url
fromUserProfilePic string

Profile picture url of the creator

GroupRemovedSchema

Name Path Type Description
Subgroup Identifier
groupId string

Identifier of the subgroup

Subgroup Name
groupName string

Name of the subgroup

Subgroup Picture url
groupPicUrl string

Picture url of the subgroup

Subgroup Type
groupType string

Type of the subgroup

Removed By
fromUser string

Mobile number of the person

Removed By
fromUserName string

Name of the person

Creator Profile Picture url
fromUserProfilePic string

Profile picture url of the creator

MemberAddedSchema

Name Path Type Description
Member Mobile Number
member string

Mobile number of the member

Member Name
memberName string

Name of the member

Member Profile Picture url
memberProfilePic string

Profile picture url of the member

Membership Type
type string

Type of membership

Added By
fromUser string

Mobile number of the person

Added By
fromUserName string

Name of the person

Creator Profile Picture url
fromUserProfilePic string

Profile picture url of the creator

MemberRemovedSchema

Name Path Type Description
Member Mobile Number
member string

Mobile number of the member

Member Name
memberName string

Name of the member

Member Profile Picture url
memberProfilePic string

Profile picture url of the member

Membership Type
type string

Type of membership

Removed By
fromUser string

Mobile number of the person

Removed By
fromUserName string

Name of the person

Creator Profile Picture url
fromUserProfilePic string

Profile picture url of the creator

SurveyCreatedSchema

Name Path Type Description
Survey Title
surveyTitle string

Title of the survey

Creator Mobile Number
fromUser string

Mobile number of the creator

Creator Name
fromUserName string

Name of the creator

Creator Profile Picture url
fromUserProfilePic string

Profile picture url of the creator

Group Id
groupId string

Group Id

Action Instance Id
actionId string

Action Instance Id

Creator User Id
fromUserId string

Creator User Id

TextMessageCreatedSchema

Name Path Type Description
Text Message
textMessage string

Text of the message

Creator Mobile Number
fromUser string

Mobile number of the creator

Creator Name
fromUserName string

Name of the creator

Creator Profile Picture url
fromUserProfilePic string

Profile picture url of the creator

Group Id
groupId string

Group Id

Source Group Id
sourceGroupId string

Source Group Id

Message Id
messageId string

Message Id

Is Reply
isReply boolean

Is Reply

Original Message Id
originalMessageId string

Original Message Id

Creator User Id
fromUserId string

Creator User Id

UserJoinedSchema

Name Path Type Description
Added By
fromUser string

Mobile number of the person

Added By
fromUserName string

Name of the person

Creator Profile Picture url
fromUserProfilePic string

Profile picture url of the creator

User Id
fromUserId string

User Id of the newly joined user

Group Id
groupId string

Group where user is added