teamsTab resource type

A teamsTab is a tab that's pinned (attached) to a channel within a team.

Methods

Method Return Type Description
List tabs teamsTab Lists tabs pinned to a channel.
Get tab teamsTab Reads a tab pinned to a channel.
Add tab teamsTab Adds (pins) a tab to a channel.
Remove tab None Removes (unpins) a tab from a channel.
Update tab teamsTab Updates the tab properties.

Properties

Property Type Description
id string Identifier that uniquely identifies a specific instance of a channel tab. Read only.
displayName string Name of the tab.
webUrl string Deep link url of the tab instance. Read only.
configuration teamsTabConfiguration Container for custom settings applied to a tab. The tab is considered configured only once this property is set.

Relationships

Relationship Type Description
teamsApp teamsApp The application that is linked to the tab. This cannot be changed after tab creation.

JSON representation

The following is a JSON representation of the resource.

{  
  "id": "string",
  "displayName": "string",
  "webUrl": "string",
  "configuration" : "teamsTabConfiguration"
}

See also

Configuring the built-in tab types