userTeamwork: sendActivityNotification

Namespace: microsoft.graph

Send an activity feed notification to a user. For more details about sending notifications and the requirements for doing so, see sending Teams activity notifications.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) TeamsActivity.Send
Delegated (personal Microsoft account) Not Supported.
Application TeamsActivity.Send

HTTP request

POST /users/{userId | user-principal-name}/teamwork/sendActivityNotification

Request headers

Name Description
Authorization Bearer {token}. Required.
Content-Type application/json. Required.

Request body

In the request body, supply JSON representation of the parameters.

The following table shows the parameters that can be used with this action.

Parameter Type Description
topic teamworkActivityTopic Topic of the notification. Specifies the resource being talked about.
activityType String Activity type. This must be declared in the Teams app manifest.
chainId Int64 Optional. Used to override a previous notification. Use the same chainId in subsequent requests to override the previous notification.
previewText itemBody Preview text for the notification. Microsoft Teams will only show first 150 characters.
templateParameters keyValuePair collection Values for template variables defined in the activity feed entry corresponding to activityType in Teams app manifest.

The following resources are supported when setting the source value of the topic property to entityUrl:

Response

If successful, this action returns a 204 No Content response code.

Examples

Example 1: Send notification to a user for a task created

Request

POST https://graph.microsoft.com/v1.0/users/{userId}/teamwork/sendActivityNotification
Content-Type: application/json

{
    "topic": {
        "source": "entityUrl",
        "value": "https://graph.microsoft.com/v1.0/users/{userId}/teamwork/installedApps/{installationId}"
    },
    "activityType": "taskCreated",
    "previewText": {
        "content": "New Task Created"
    },
    "templateParameters": [
        {
            "name": "taskId",
            "value": "Task 12322"
        }
    ]
}

Response

HTTP/1.1 204 No Content

Example 2: Notify a user about an event using custom topic

If you want to link an aspect that is not represented by Microsoft Graph, or you want to customize the name, you can set the source of the topic to text and pass in a custom value for it. webUrl is required when using topic source as text.

Request

POST https://graph.microsoft.com/v1.0/users/{userId}/teamwork/sendActivityNotification
Content-Type: application/json

{
    "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"
    },
    "templateParameters": [
        {
            "name": "deploymentId",
            "value": "6788662"
        }
    ]
}

Response

HTTP/1.1 204 No Content