Connectors Reference

Microsoft Kaizala

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.

 

Status: Preview

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

SendMessage (string groupId, SendMessageRequest request, [advanced][Optional]string sendToAll)

Send text message to a group

GetActions (string groupId, [Optional]string actionType, [Optional]string id)

Get the list of actions on a group

SendActions (string groupId, [Optional]string actionType, [Optional]string id, SendActionRequest request, [advanced][Optional]string sendToAll)

Send action on a group

GetActionPackages (string groupId)

Get the list of action packages on a group

CreateGroup (CreateGroupRequest request)

Create a group

AddGroupToGroup (string groupId, [Optional]AddGroupToGroupRequest request)

Add an existing group as subgroup

CreateSubgroup (string groupId, CreateGroupRequest request)

Create a subgroup

RemoveGroupFromGroup (string groupId, string subGroupId)

Remove a subgroup from group

AddUserToGroup (string groupId, AddUserToGroupRequest request)

Add user to group

AddSubscriberToGroup (string groupId, AddSubscriberToGroupRequest request)

Add subscriber to group

RemoveUserFromGroup (string groupId, string memberId)

Remove user from a group

UploadMediaFileContent (file fileContent)

Upload a media file

UploadMediaFromURL (UploadMediaFromURLRequest mediaUrl)

Upload media from url

UploadMediaFromAttachment (UploadMediaFromAttachmentRequest request)

Upload media from attachment

GetEventInfoSchema (string type)

GetEventInfoSchema

GetSubscriptionObjectTypes ()

Get subscription object types

GetSubscriptionObjectIds (string objectType)

Get subscription object ids

GetEventTypeForObject (string objectType)

Get event type for object

GetDynamicGroups ()

Get a list of groups

GetDynamicGroupMembers (string groupId)

Get list of members for a group

GetActionBodySchema (string type)

Get action body schema

GetSurveyDetails (string groupId, string actionId)

Survey details schema

GetActionDetails (string groupId, string actionPackageId, string objectId)

Action details schema

WebhookResponse ([Optional]string flowUri)

 

 

Triggers:

Name

Summary

ActionCreatedOnGroup (string objectId, AddOutgoingWebhookRequest request)

When a custom action is sent in a group

AnnouncementOnGroup (string objectId, AddOutgoingWebhookRequest request)

When there is an announcement sent in a group

GroupAddedToGroup (string objectId, AddOutgoingWebhookRequest request)

When a group is added as a member to a group

GroupRemovedFromGroup (string objectId, AddOutgoingWebhookRequest request)

When a group is removed as a member to a group

MemberAddedToGroup (string objectId, AddOutgoingWebhookRequest request)

When a member is added to a group

MemberRemovedFromGroup (string objectId, AddOutgoingWebhookRequest request)

When a member is removed from a group

SurveyCreatedOnGroup (string objectId, AddOutgoingWebhookRequest request)

When a survey is sent in a group

TextMessageCreatedOnGroup (string objectId, AddOutgoingWebhookRequest request)

When a text message is sent on a group

SurveyResponseOnGroup (string groupId, string objectId, AddOutgoingWebhookRequest request)

When someone responds to a survey

AttachmentOnGroup (string objectId, AddOutgoingWebhookRequest request)

When there is an attachment sent in a group

ActionResponseOnGroup (string groupId, string actionPackageId, string objectId, AddOutgoingWebhookRequest request)

When someone responds to a custom action

 

Objects:

Name

Summary

ActionBodyInfo

Action Body

AddGroupToGroupRequest

 

AddOutgoingWebhookRequest

 

AddSubscriberToGroupRequest

 

AddUserToGroupRequest

 

CreateGroupRequest

 

CreateGroupResponse

 

DynamicGroupItem

 

DynamicGroupList

 

DynamicSubscriptionObjectItem

 

DynamicSubscriptionObjectList

 

file

File Content

GetEventInfoSchemaResponse

 

SendActionRequest

 

SendActionResponse

 

SendMessageRequest

 

SendMessageResponse

 

UploadMediaFromAttachmentRequest

 

UploadMediaFromURLRequest

 

UploadMediaResponse

 

 

Actions:

SendMessage

Summary: Send text message to a group

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

 

Syntax:

MicrosoftKaizala.SendMessage (string groupId, SendMessageRequest request, [advanced][Optional]string sendToAll)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupId

string

(Group)

Select a Group on which action will be performed.

True

GetDynamicGroups

request

SendMessageRequest

 

 

True

sendToAll

string

(Send to all Subscribers)Values: [Yes, No]

Select option

False

 

Returns:

          Type:SendMessageResponse

 

GetActions

Summary: Get the list of actions on a group

Description: This operation allows you to get the list of actions in a group.

 

Syntax:

MicrosoftKaizala.GetActions (string groupId, [Optional]string actionType, [Optional]string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupId

string

(Group)

Select a Group on which action will be performed.

True

GetDynamicGroups

actionType

string

(Action Type)

 

False

id

string

(Action ID)

 

False

 

Returns:

          Type:DynamicGroupList

 

SendActions

Summary: Send action on a group

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

 

Syntax:

MicrosoftKaizala.SendActions (string groupId, [Optional]string actionType, [Optional]string id, SendActionRequest request, [advanced][Optional]string sendToAll)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupId

string

(Group)

Select a Group on which action will be performed.

True

GetDynamicGroups

actionType

string

(Action)Values: [job, survey, image, audio, document, album, announcement]

Select Action type.

False

id

string

(Action Package)

Select an action package.

False

GetActionPackages

request

SendActionRequest

 

 

True

sendToAll

string

(Send to all Subscribers)Values: [Yes, No]

Select option

False

 

Returns:

          Type:SendActionResponse

 

GetActionPackages

Summary: Get the list of action packages on a group

Description: This operation allows you to get the list of action packages in a group.

 

Syntax:

MicrosoftKaizala.GetActionPackages (string groupId)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupId

string

 

 

True

 

Returns:

          Type:DynamicGroupList

 

CreateGroup

Summary: Create a group

Description: This operation allows you to create a Kaizala group.

 

Syntax:

MicrosoftKaizala.CreateGroup (CreateGroupRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

CreateGroupRequest

 

 

True

 

Returns:

          Type:CreateGroupResponse

 

AddGroupToGroup

Summary: Add an existing group as subgroup

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

 

Syntax:

MicrosoftKaizala.AddGroupToGroup (string groupId, [Optional]AddGroupToGroupRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupId

string

(Group)

Select a Group on which action will be performed.

True

GetDynamicGroups

request

AddGroupToGroupRequest

 

 

False

 

Returns:

 

CreateSubgroup

Summary: Create a subgroup

Description: This operation allows creation of a subgroup within a group.

 

Syntax:

MicrosoftKaizala.CreateSubgroup (string groupId, CreateGroupRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupId

string

(Group)

Select a Group on which action will be performed.

True

GetDynamicGroups

request

CreateGroupRequest

 

 

True

 

Returns:

 

RemoveGroupFromGroup

Summary: Remove a subgroup from group

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

 

Syntax:

MicrosoftKaizala.RemoveGroupFromGroup (string groupId, string subGroupId)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupId

string

(Group)

Select a Group on which action will be performed.

True

GetDynamicGroups

subGroupId

string

(Sub-group Identifier)

Enter an identifier for the sub-group.

True

 

Returns:

 

AddUserToGroup

Summary: Add user to group

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

 

Syntax:

MicrosoftKaizala.AddUserToGroup (string groupId, AddUserToGroupRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupId

string

(Group)

Select a Group on which action will be performed.

True

GetDynamicGroups

request

AddUserToGroupRequest

 

 

True

 

Returns:

 

AddSubscriberToGroup

Summary: Add subscriber to group

Description: This operation allows you to add subscribers to a group.

 

Syntax:

MicrosoftKaizala.AddSubscriberToGroup (string groupId, AddSubscriberToGroupRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupId

string

(Group)

Select a Group on which action will be performed.

True

GetDynamicGroups

request

AddSubscriberToGroupRequest

 

 

True

 

Returns:

 

RemoveUserFromGroup

Summary: Remove user from a group

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

 

Syntax:

MicrosoftKaizala.RemoveUserFromGroup (string groupId, string memberId)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupId

string

(Group)

Select a Group on which action will be performed.

True

GetDynamicGroups

memberId

string

(Select a member)

The id of the member

True

GetDynamicGroupMembers

 

Returns:

 

UploadMediaFileContent

Summary: Upload a media file

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

 

Syntax:

MicrosoftKaizala.UploadMediaFileContent (file fileContent)

 

Parameters:

Name

Type

Summary

Required

Related Action

fileContent

file

(File Content)

The media should be in multipart form.

True

 

Returns:

          Type:UploadMediaResponse

 

UploadMediaFromURL

Summary: Upload media from url

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

 

Syntax:

MicrosoftKaizala.UploadMediaFromURL (UploadMediaFromURLRequest mediaUrl)

 

Parameters:

Name

Type

Summary

Required

Related Action

mediaUrl

UploadMediaFromURLRequest

 

 

True

 

Returns:

          Type:UploadMediaResponse

 

UploadMediaFromAttachment

Summary: Upload media from attachment

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

 

Syntax:

MicrosoftKaizala.UploadMediaFromAttachment (UploadMediaFromAttachmentRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

UploadMediaFromAttachmentRequest

 

 

True

 

Returns:

          Type:UploadMediaResponse

 

GetEventInfoSchema

Summary: GetEventInfoSchema

Description: Get Action body schema for the selected action type.

 

Syntax:

MicrosoftKaizala.GetEventInfoSchema (string type)

 

Parameters:

Name

Type

Summary

Required

Related Action

type

string

 

 

True

 

Returns:

          Type:GetEventInfoSchemaResponse

 

GetSubscriptionObjectTypes

Summary: Get subscription object types

Description: Select events you want to subscribe.

 

Syntax:

MicrosoftKaizala.GetSubscriptionObjectTypes ()

 

Returns:

          Type:DynamicSubscriptionObjectList

 

GetSubscriptionObjectIds

Summary: Get subscription object ids

Description: Select event IDs you want to subscribe.

 

Syntax:

MicrosoftKaizala.GetSubscriptionObjectIds (string objectType)

 

Parameters:

Name

Type

Summary

Required

Related Action

objectType

string

 

 

True

 

Returns:

          Type:DynamicSubscriptionObjectList

 

GetEventTypeForObject

Summary: Get event type for object

Description: Select event objects you want to subscribe.

 

Syntax:

MicrosoftKaizala.GetEventTypeForObject (string objectType)

 

Parameters:

Name

Type

Summary

Required

Related Action

objectType

string

 

 

True

 

Returns:

          Type:DynamicSubscriptionObjectList

 

GetDynamicGroups

Summary: Get a list of groups

Description: Select a group.

 

Syntax:

MicrosoftKaizala.GetDynamicGroups ()

 

Returns:

          Type:DynamicGroupList

 

GetDynamicGroupMembers

Summary: Get list of members for a group

Description: Select a group member.

 

Syntax:

MicrosoftKaizala.GetDynamicGroupMembers (string groupId)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupId

string

 

 

True

 

Returns:

          Type:DynamicGroupList

 

GetActionBodySchema

Summary: Get action body schema

Description: Get schema for a selected action type.

 

Syntax:

MicrosoftKaizala.GetActionBodySchema (string type)

 

Parameters:

Name

Type

Summary

Required

Related Action

type

string

 

 

True

 

Returns:

          Type:string

 

GetSurveyDetails

Summary: Survey details schema

Description: Get schema for survey details.

 

Syntax:

MicrosoftKaizala.GetSurveyDetails (string groupId, string actionId)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupId

string

 

 

True

actionId

string

 

 

True

 

Returns:

          Type:string

 

GetActionDetails

Summary: Action details schema

Description: Get schema for action details.

 

Syntax:

MicrosoftKaizala.GetActionDetails (string groupId, string actionPackageId, string objectId)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupId

string

 

 

True

actionPackageId

string

 

 

True

objectId

string

 

 

True

 

Returns:

          Type:string

 

WebhookResponse

Summary:

Description:

 

Syntax:

MicrosoftKaizala.WebhookResponse ([Optional]string flowUri)

 

Parameters:

Name

Type

Summary

Required

Related Action

flowUri

string

 

 

False

 

Returns:

 

Triggers:

Trigger ActionCreatedOnGroup

Summary: When a custom action is sent in a group

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

 

Syntax:

MicrosoftKaizala.ActionCreatedOnGroup (string objectId, AddOutgoingWebhookRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

objectId

string

(Group)

Select a group.

True

GetDynamicGroups

request

AddOutgoingWebhookRequest

 

 

True

 

Returns:

          Type:string

 

Trigger AnnouncementOnGroup

Summary: When there is an announcement sent in a group

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

 

Syntax:

MicrosoftKaizala.AnnouncementOnGroup (string objectId, AddOutgoingWebhookRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

objectId

string

(Group)

Select a group.

True

GetDynamicGroups

request

AddOutgoingWebhookRequest

 

 

True

 

Returns:

          Type:string

 

Trigger GroupAddedToGroup

Summary: When a group is added as a member to a group

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

 

Syntax:

MicrosoftKaizala.GroupAddedToGroup (string objectId, AddOutgoingWebhookRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

objectId

string

(Group)

Select a group.

True

GetDynamicGroups

request

AddOutgoingWebhookRequest

 

 

True

 

Returns:

          Type:string

 

Trigger GroupRemovedFromGroup

Summary: When a group is removed as a member to a group

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

 

Syntax:

MicrosoftKaizala.GroupRemovedFromGroup (string objectId, AddOutgoingWebhookRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

objectId

string

(Group)

Select a group.

True

GetDynamicGroups

request

AddOutgoingWebhookRequest

 

 

True

 

Returns:

          Type:string

 

Trigger MemberAddedToGroup

Summary: When a member is added to a group

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

 

Syntax:

MicrosoftKaizala.MemberAddedToGroup (string objectId, AddOutgoingWebhookRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

objectId

string

(Group)

Select a group.

True

GetDynamicGroups

request

AddOutgoingWebhookRequest

 

 

True

 

Returns:

          Type:string

 

Trigger MemberRemovedFromGroup

Summary: When a member is removed from a group

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

 

Syntax:

MicrosoftKaizala.MemberRemovedFromGroup (string objectId, AddOutgoingWebhookRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

objectId

string

(Group)

Select a group.

True

GetDynamicGroups

request

AddOutgoingWebhookRequest

 

 

True

 

Returns:

          Type:string

 

Trigger SurveyCreatedOnGroup

Summary: When a survey is sent in a group

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

 

Syntax:

MicrosoftKaizala.SurveyCreatedOnGroup (string objectId, AddOutgoingWebhookRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

objectId

string

(Group)

Select a group.

True

GetDynamicGroups

request

AddOutgoingWebhookRequest

 

 

True

 

Returns:

          Type:string

 

Trigger TextMessageCreatedOnGroup

Summary: When a text message is sent on a group

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

 

Syntax:

MicrosoftKaizala.TextMessageCreatedOnGroup (string objectId, AddOutgoingWebhookRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

objectId

string

(Group)

Select a group.

True

GetDynamicGroups

request

AddOutgoingWebhookRequest

 

 

True

 

Returns:

          Type:string

 

Trigger SurveyResponseOnGroup

Summary: When someone responds to a survey

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

 

Syntax:

MicrosoftKaizala.SurveyResponseOnGroup (string groupId, string objectId, AddOutgoingWebhookRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupId

string

(Group)

Select a group.

True

GetDynamicGroups

objectId

string

(Survey)

Select a survey.

True

GetActions

request

AddOutgoingWebhookRequest

 

 

True

 

Returns:

          Type:string

 

Trigger AttachmentOnGroup

Summary: When there is an attachment sent in a group

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

 

Syntax:

MicrosoftKaizala.AttachmentOnGroup (string objectId, AddOutgoingWebhookRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

objectId

string

(Group)

Select a group.

True

GetDynamicGroups

request

AddOutgoingWebhookRequest

 

 

True

 

Returns:

          Type:string

 

Trigger ActionResponseOnGroup

Summary: When someone responds to a custom action

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

 

Syntax:

MicrosoftKaizala.ActionResponseOnGroup (string groupId, string actionPackageId, string objectId, AddOutgoingWebhookRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupId

string

(Group)

Select a group.

True

GetDynamicGroups

actionPackageId

string

(Action Package)

Select an action package.

True

GetActionPackages

objectId

string

(Action)

Select a custom action.

True

GetActions

request

AddOutgoingWebhookRequest

 

 

True

 

Returns:

          Type:string

 


 

ActionBodyInfo

Summary: Action Body

Description: Action body.

 

          Properties:

Name

Type

Summary


 

AddGroupToGroupRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

SubGroups

array of (string)

 

 


 

AddOutgoingWebhookRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

CallbackUrl

string

Callback Url

 

CallbackToken

string

Callback Token

 

CallbackContext

string

Callback Context

 

Validity

integer(int64)

Validity

 


 

AddSubscriberToGroupRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

subscribers

string

Subscribers

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


 

AddUserToGroupRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

Members

string

Members

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


 

CreateGroupRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

Name

string

Group Name

Name of the group to be created.

WelcomeMessage

string

Welcome Message

Enter a welcome message for the members of a group.

Members

string

Members

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

GroupType

string

Group Type

Select the type of group.  Values: [group, connectGroup]

ShortDescriptionString

string

Short Description

Enter a short description for the group.

LongDescriptionString

string

Long Description

Enter a long description for the group.


 

CreateGroupResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

groupId

string

 

Group identifier of the created group.


 

DynamicGroupItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Id

string

 

 

Name

string

 

 


 

DynamicGroupList

Summary:

Description:

 

          Properties:

Name

Type

Summary

Groups

array of (DynamicGroupItem)

 

 


 

DynamicSubscriptionObjectItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Id

string

 

 

Name

string

 

 


 

DynamicSubscriptionObjectList

Summary:

Description:

 

          Properties:

Name

Type

Summary

SubscriptionObjectItem

array of (DynamicSubscriptionObjectItem)

 

 


 

file

Summary: File Content

Description: The media should be in multipart form.

 

          Properties:

Name

Type

Summary


 

GetEventInfoSchemaResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

SendActionRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

actionBody

ActionBodyInfo

Action Body

Action body.

subscribers

string

Subscribers

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


 

SendActionResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

referenceId

string

Reference Id

Reference Id.

actionId

string

Action instance Id

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


 

SendMessageRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

Message

string

Message

Enter a text message.

subscribers

string

Subscribers

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


 

SendMessageResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

referenceId

string

Reference Id

Reference Id.


 

UploadMediaFromAttachmentRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileContent

FileContent

Media file

Media file in Base64 format

 

FileContent

Summary: Media file

Description: Media file in Base64 format

 

          Properties:

Name

Type

Summary

 


 

UploadMediaFromURLRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

mediaUrl

string

Media url

Url of the media file.


 

UploadMediaResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

mediaResource

string

 

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