Send-MgChatActivityNotification

Module:

Microsoft.Graph.Teams

Send an activity feed notification in scope of a chat. For more information about sending notifications and the requirements for doing so, see sending Teams activity notifications.

Note

To view the beta release of this cmdlet, view Send-MgBetaChatActivityNotification

Syntax

Send-MgChatActivityNotification
    -ChatId <String>
    [-ResponseHeadersVariable <String>]
    [-ActivityType <String>]
    [-AdditionalProperties <Hashtable>]
    [-ChainId <Int64>]
    [-PreviewText <IMicrosoftGraphItemBody>]
    [-Recipient <Hashtable>]
    [-TeamsAppId <String>]
    [-TemplateParameters <IMicrosoftGraphKeyValuePair[]>]
    [-Topic <IMicrosoftGraphTeamworkActivityTopic>]
    [-Headers <IDictionary>]
    [-PassThru]
    [-ProgressAction <ActionPreference>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Send-MgChatActivityNotification
    -ChatId <String>
    -BodyParameter <IPaths1BjzoobChatsChatIdMicrosoftGraphSendactivitynotificationPostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-PassThru]
    [-ProgressAction <ActionPreference>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Send-MgChatActivityNotification
    -InputObject <ITeamsIdentity>
    [-ResponseHeadersVariable <String>]
    [-ActivityType <String>]
    [-AdditionalProperties <Hashtable>]
    [-ChainId <Int64>]
    [-PreviewText <IMicrosoftGraphItemBody>]
    [-Recipient <Hashtable>]
    [-TeamsAppId <String>]
    [-TemplateParameters <IMicrosoftGraphKeyValuePair[]>]
    [-Topic <IMicrosoftGraphTeamworkActivityTopic>]
    [-Headers <IDictionary>]
    [-PassThru]
    [-ProgressAction <ActionPreference>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Send-MgChatActivityNotification
    -InputObject <ITeamsIdentity>
    -BodyParameter <IPaths1BjzoobChatsChatIdMicrosoftGraphSendactivitynotificationPostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-PassThru]
    [-ProgressAction <ActionPreference>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Send an activity feed notification in scope of a chat. For more information about sending notifications and the requirements for doing so, see sending Teams activity notifications.

Examples

Example 1: Notify a user about a task created in a chat

Import-Module Microsoft.Graph.Teams

$params = @{
	topic = @{
		source = "entityUrl"
		value = "https://graph.microsoft.com/v1.0/chats/{chatId}"
	}
	activityType = "taskCreated"
	previewText = @{
		content = "New Task Created"
	}
	recipient = @{
		"@odata.type" = "microsoft.graph.aadUserNotificationRecipient"
		userId = "569363e2-4e49-4661-87f2-16f245c5d66a"
	}
	templateParameters = @(
		@{
			name = "taskId"
			value = "Task 12322"
		}
	)
}

Send-MgChatActivityNotification -ChatId $chatId -BodyParameter $params

This example will notify a user about a task created in a chat

Example 2: Notify a user about an approval needed in a chat message

Import-Module Microsoft.Graph.Teams

$params = @{
	topic = @{
		source = "entityUrl"
		value = "https://graph.microsoft.com/v1.0/chats/{chatId}/messages/{messageId}"
	}
	activityType = "approvalRequired"
	previewText = @{
		content = "Deployment requires your approval"
	}
	recipient = @{
		"@odata.type" = "microsoft.graph.aadUserNotificationRecipient"
		userId = "569363e2-4e49-4661-87f2-16f245c5d66a"
	}
	templateParameters = @(
		@{
			name = "approvalTaskId"
			value = "2020AAGGTAPP"
		}
	)
}

Send-MgChatActivityNotification -ChatId $chatId -BodyParameter $params

This example will notify a user about an approval needed in a chat message

Example 3: Notify a user about an approval needed in a chat message using user principal name

Import-Module Microsoft.Graph.Teams

$params = @{
	topic = @{
		source = "entityUrl"
		value = "https://graph.microsoft.com/v1.0/chats/{chatId}/messages/{messageId}"
	}
	activityType = "approvalRequired"
	previewText = @{
		content = "Deployment requires your approval"
	}
	recipient = @{
		"@odata.type" = "microsoft.graph.aadUserNotificationRecipient"
		userId = "jacob@contoso.com"
	}
	templateParameters = @(
		@{
			name = "approvalTaskId"
			value = "2020AAGGTAPP"
		}
	)
}

Send-MgChatActivityNotification -ChatId $chatId -BodyParameter $params

This example will notify a user about an approval needed in a chat message using user principal name

Example 4: Notify a user about an event in relation to a chat

Import-Module Microsoft.Graph.Teams

$params = @{
	topic = @{
		source = "text"
		value = "Deployment Approvals Channel"
		webUrl = "https://teams.microsoft.com/l/message/19:448cfd2ac2a7490a9084a9ed14cttr78c@thread.skype/1605223780000?tenantId=c8b1bf45-3834-4ecf-971a-b4c755ee677d&groupId=d4c2a937-f097-435a-bc91-5c1683ca7245&parentMessageId=1605223771864&teamName=Approvals&channelName=Azure%20DevOps&createdTime=1605223780000"
	}
	activityType = "deploymentApprovalRequired"
	previewText = @{
		content = "New deployment requires your approval"
	}
	recipient = @{
		"@odata.type" = "microsoft.graph.aadUserNotificationRecipient"
		userId = "569363e2-4e49-4661-87f2-16f245c5d66a"
	}
	templateParameters = @(
		@{
			name = "deploymentId"
			value = "6788662"
		}
	)
}

Send-MgChatActivityNotification -ChatId $chatId -BodyParameter $params

This example will notify a user about an event in relation to a chat

Example 5: Notify the chat members about a task created in a chat

Import-Module Microsoft.Graph.Teams

$params = @{
	topic = @{
		source = "entityUrl"
		value = "https://graph.microsoft.com/v1.0/chats/19:1c3af46e9e0f4a5293343c8813c47619@thread.v2"
	}
	activityType = "taskCreated"
	previewText = @{
		content = "New Task Created"
	}
	recipient = @{
		"@odata.type" = "microsoft.graph.chatMembersNotificationRecipient"
		chatId = "19:1c3af46e9e0f4a5293343c8813c47619@thread.v2"
	}
	templateParameters = @(
		@{
			name = "taskId"
			value = "Task 12322"
		}
	)
}

Send-MgChatActivityNotification -ChatId $chatId -BodyParameter $params

This example will notify the chat members about a task created in a chat

Parameters

-ActivityType

.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AdditionalProperties

Additional Parameters

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BodyParameter

. To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Type:	IPaths1BjzoobChatsChatIdMicrosoftGraphSendactivitynotificationPostRequestbodyContentApplicationJsonSchema
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ChainId

.

Type:	Int64
Position:	Named
Default value:	0
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ChatId

The unique identifier of chat

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Headers

Optional headers that will be added to the request.

Type:	IDictionary
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	ITeamsIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-PassThru

Returns true when the command succeeds

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PreviewText

itemBody To construct, see NOTES section for PREVIEWTEXT properties and create a hash table.

Type:	IMicrosoftGraphItemBody
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProgressAction

{{ Fill ProgressAction Description }}

Type:	ActionPreference
Aliases:	proga
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Recipient

teamworkNotificationRecipient

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:	String
Aliases:	RHV
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TeamsAppId

.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TemplateParameters

. To construct, see NOTES section for TEMPLATEPARAMETERS properties and create a hash table.

Type:	IMicrosoftGraphKeyValuePair[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Topic

teamworkActivityTopic To construct, see NOTES section for TOPIC properties and create a hash table.

Type:	IMicrosoftGraphTeamworkActivityTopic
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.Graph.PowerShell.Models.IPaths1BjzoobChatsChatIdMicrosoftGraphSendactivitynotificationPostRequestbodyContentApplicationJsonSchema

Microsoft.Graph.PowerShell.Models.ITeamsIdentity

System.Collections.IDictionary

Outputs

System.Boolean

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

BODYPARAMETER <IPaths1BjzoobChatsChatIdMicrosoftGraphSendactivitynotificationPostRequestbodyContentApplicationJsonSchema>: .

• [(Any) <Object>]: This indicates any property can be added to this object.
• [ActivityType <String>]:
• [ChainId <Int64?>]:
• [PreviewText <IMicrosoftGraphItemBody>]: itemBody
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Content <String>]: The content of the item.
  • [ContentType <String>]: bodyType
• [Recipient <IMicrosoftGraphTeamworkNotificationRecipient>]: teamworkNotificationRecipient
  • [(Any) <Object>]: This indicates any property can be added to this object.
• [TeamsAppId <String>]:
• [TemplateParameters <IMicrosoftGraphKeyValuePair- []>]:
  • [Name <String>]: Name for this key-value pair
  • [Value <String>]: Value for this key-value pair
• [Topic <IMicrosoftGraphTeamworkActivityTopic>]: teamworkActivityTopic
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Source <String>]: teamworkActivityTopicSource
  • [Value <String>]: The topic value. If the value of the source property is entityUrl, this must be a Microsoft Graph URL. If the value is text, this must be a plain text value.
  • [WebUrl <String>]: The link the user clicks when they select the notification. Optional when source is entityUrl; required when source is text.

INPUTOBJECT <ITeamsIdentity>: Identity Parameter

• [AssociatedTeamInfoId <String>]: The unique identifier of associatedTeamInfo
• [ChannelId <String>]: The unique identifier of channel
• [ChatId <String>]: The unique identifier of chat
• [ChatMessageHostedContentId <String>]: The unique identifier of chatMessageHostedContent
• [ChatMessageId <String>]: The unique identifier of chatMessage
• [ChatMessageId1 <String>]: The unique identifier of chatMessage
• [ConversationMemberId <String>]: The unique identifier of conversationMember
• [DeletedChatId <String>]: The unique identifier of deletedChat
• [DeletedTeamId <String>]: The unique identifier of deletedTeam
• [GroupId <String>]: The unique identifier of group
• [OfferShiftRequestId <String>]: The unique identifier of offerShiftRequest
• [OpenShiftChangeRequestId <String>]: The unique identifier of openShiftChangeRequest
• [OpenShiftId <String>]: The unique identifier of openShift
• [PinnedChatMessageInfoId <String>]: The unique identifier of pinnedChatMessageInfo
• [ResourceSpecificPermissionGrantId <String>]: The unique identifier of resourceSpecificPermissionGrant
• [SchedulingGroupId <String>]: The unique identifier of schedulingGroup
• [SharedWithChannelTeamInfoId <String>]: The unique identifier of sharedWithChannelTeamInfo
• [ShiftId <String>]: The unique identifier of shift
• [SwapShiftsChangeRequestId <String>]: The unique identifier of swapShiftsChangeRequest
• [TeamId <String>]: The unique identifier of team
• [TeamsAppDefinitionId <String>]: The unique identifier of teamsAppDefinition
• [TeamsAppId <String>]: The unique identifier of teamsApp
• [TeamsAppInstallationId <String>]: The unique identifier of teamsAppInstallation
• [TeamsAsyncOperationId <String>]: The unique identifier of teamsAsyncOperation
• [TeamsTabId <String>]: The unique identifier of teamsTab
• [TeamworkTagId <String>]: The unique identifier of teamworkTag
• [TeamworkTagMemberId <String>]: The unique identifier of teamworkTagMember
• [TimeOffId <String>]: The unique identifier of timeOff
• [TimeOffReasonId <String>]: The unique identifier of timeOffReason
• [TimeOffRequestId <String>]: The unique identifier of timeOffRequest
• [UserId <String>]: The unique identifier of user
• [UserScopeTeamsAppInstallationId <String>]: The unique identifier of userScopeTeamsAppInstallation
• [WorkforceIntegrationId <String>]: The unique identifier of workforceIntegration

PREVIEWTEXT <IMicrosoftGraphItemBody>: itemBody

• [(Any) <Object>]: This indicates any property can be added to this object.
• [Content <String>]: The content of the item.
• [ContentType <String>]: bodyType

TEMPLATEPARAMETERS <IMicrosoftGraphKeyValuePair- []>: .

• [Name <String>]: Name for this key-value pair
• [Value <String>]: Value for this key-value pair

TOPIC <IMicrosoftGraphTeamworkActivityTopic>: teamworkActivityTopic

• [(Any) <Object>]: This indicates any property can be added to this object.
• [Source <String>]: teamworkActivityTopicSource
• [Value <String>]: The topic value. If the value of the source property is entityUrl, this must be a Microsoft Graph URL. If the value is text, this must be a plain text value.
• [WebUrl <String>]: The link the user clicks when they select the notification. Optional when source is entityUrl; required when source is text.

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.teams/send-mgchatactivitynotification
• https://learn.microsoft.com/graph/api/chat-sendactivitynotification?view=graph-rest-1.0