root.activities.activityTypes object

Array of objects representing activity notifications that your app can post to a user's activity feed in Teams. The systemDefault activity type is a reserved value and invalid for use.

Properties that reference this object type:

• root.activities.activityTypes

Syntax

Syntax

{
  "type": "{string}",
  "description": "{string}",
  "templateText": "{string}",
  "allowedIconIds": [
    "{string}"
  ]
}

Schema

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "maxLength": 64
    },
    "description": {
      "type": "string",
      "maxLength": 128
    },
    "templateText": {
      "type": "string",
      "maxLength": 128
    },
    "allowedIconIds": {
      "type": "array",
      "description": "An array containing valid icon IDs per activity type.",
      "maxItems": 50,
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "type",
    "description",
    "templateText"
  ],
  "additionalProperties": false
}

Properties

type

The notification type.

Type
string

Required
✅

Constraints
Maximum string length: 64.

Supported values

description

A brief description of the notification.

This property is localizable. For more information, see the localization schema.

Type
string

Required
✅

Constraints
Maximum string length: 128.

Supported values

templateText

Text template for the notification. For example: "{actor} created task {taskId} for you"

This property is localizable. For more information, see the localization schema.

Type
string

Required
✅

Constraints
Maximum string length: 128.

Supported values

allowedIconIds

An array containing valid icon IDs per activity type.

Type
Array of string

Required
—

Constraints
Maximum array items: 50.

Supported values

Examples

{
   "activities":{
      "activityTypes":[
         {
            "type":"taskCreated",
            "description":"Task Created Activity",
            "templateText":"{actor} created task {taskId} for you"
         },
         {
            "type":"teamMention",
            "description":"Team Mention Activity",
            "templateText":"{actor} mentioned team"
         },
         {
            "type":"channelMention",
            "description":"Channel Mention Activity",
            "templateText":"{actor} mentioned channel"
         },
         {
            "type":"userMention",
            "description":"Personal Mention Activity",
            "templateText":"{actor} mentioned user"
         },
         {
            "type":"calendarForward",
            "description":"Forwarding a Calendar Event",
            "templateText":"{actor} sent user an invite on behalf of {eventOwner}"
         },
         {
            "type":"calendarForward",
            "description":"Forwarding a Calendar Event",
            "templateText":"{actor} sent user an invite on behalf of {eventOwner}"
         },
         {
            "type":"creatorTaskCreated",
            "description":"Created Task Created",
            "templateText":"The Creator created task {taskId} for you"
         }
      ]
   }
}