Microsoft Teams is currently in beta. The info in this guide is subject to change.
This integration is powered by Singer's Microsoft Teams tap and certified by Stitch. Check out and contribute to the repo on GitHub.
For support, contact Stitch support.
Microsoft Teams integration summary
Stitch’s Microsoft Teams integration replicates data using the Microsoft Graph API. Refer to the Schema section for a list of objects available for replication.
Microsoft Teams feature snapshot
A high-level look at Stitch's Microsoft Teams (v1) integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release status |
Beta |
Supported by | |
Stitch plan |
Standard |
API availability |
Available |
Singer GitHub repository | |||
REPLICATION SETTINGS | |||
Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
DATA SELECTION | |||
Table selection |
Supported |
Column selection |
Supported |
Select all |
Supported |
||
TRANSPARENCY | |||
Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Microsoft Teams
Microsoft Teams setup requirements
To set up Microsoft Teams in Stitch, you need:
-
A Microsoft Azure account.
Step 1: Add Microsoft Teams as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Microsoft Teams icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Microsoft Teams” would create a schema called
stitch_microsoft_teams
in the destination. Note: Schema names cannot be changed after you save the integration.
Step 2: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Microsoft Teams integration. This means that:
- For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
- For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.
Change this setting if you want to replicate data beyond Microsoft Teams’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 3: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Microsoft Teams integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 4: Authorize Stitch to access Microsoft Teams
- Next, you’ll be redirected to Microsoft Teams.
- Log into your Microsoft Teams account and complete the authorization process. When finished, you’ll be redirected back to Stitch.
- Click All Done.
Step 5: Set objects to replicate
The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For Microsoft Teams integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up Microsoft Teams, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Microsoft Teams table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the Microsoft Teams integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs
> customers
), while case is maintained in PostgreSQL destinations (CusTomERs
> CusTomERs
). Refer to the Loading Guide for your destination for more info.
channels
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The channels
table contains information about the channels within a team in your Microsoft account.
id
The channel ID. Reference: |
description
|
display_name
|
email
|
web_url
|
channel_members
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The channel_members
table contains information about conversation members within a chat or channel in your Microsoft account.
id
The conversation member ID. |
channel_id
The channel ID. Reference: |
display_name
|
email
|
roles
|
user_id
The user ID. Reference: |
channel_messages
Replication Method : |
Key-based Incremental |
Replication Key |
lastModified_date_time |
Primary Key |
id |
API endpoint : |
The channel_messages
table contains information about messages in a channel, without replies, in your Microsoft account.
id
The message ID. |
||||||||||
lastModified_date_time
The time the message was last updated. |
||||||||||
attachments
|
||||||||||
body
|
||||||||||
channel_identity
|
||||||||||
chat_id
|
||||||||||
created_date_time
|
||||||||||
deleted_date_time
|
||||||||||
etag
|
||||||||||
from
|
||||||||||
importance
|
||||||||||
locale
|
||||||||||
mentions
|
||||||||||
message_type
|
||||||||||
policy_violation
|
||||||||||
reactions
|
||||||||||
reply_to_id
|
||||||||||
subject
|
||||||||||
summary
|
||||||||||
web_url
|
channel_message_replies
Replication Method : |
Key-based Incremental |
Replication Key |
last_modified_date_time |
Primary Key |
id |
API endpoint : |
The channel_message_replies
table contains information about message replies within a channel in one of your Microsoft teams.
id
The message reply ID. |
||||||||||
last_modified_date_time
The time the reply was last modified. |
||||||||||
attachments
|
||||||||||
body
|
||||||||||
channel_identity
|
||||||||||
chat_id
|
||||||||||
created_date_time
|
||||||||||
deleted_date_time
|
||||||||||
etag
|
||||||||||
from
|
||||||||||
importance
|
||||||||||
locale
|
||||||||||
mentions
|
||||||||||
message_type
|
||||||||||
policy_violation
|
||||||||||
reactions
|
||||||||||
reply_to_id
|
||||||||||
subject
|
||||||||||
summary
|
||||||||||
web_url
|
channel_tabs
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The channel_tabs
table contains information about tabs within a channel in one of your Microsoft teams.
id
The channel tab ID. |
|||||||
channel_id
The channel ID. Reference: |
|||||||
configuration
|
|||||||
display_name
|
|||||||
group_id
The group ID. Reference: |
|||||||
sort_order_index
|
|||||||
teams_app
|
|||||||
web_url
|
conversations
Replication Method : |
Key-based Incremental |
Replication Key |
last_delivered_date_time |
Primary Key |
id |
API endpoint : |
The conversations
table contains information about conversations within a group in your Microsoft account.
id
The conversation ID. |
last_delivered_date_time
The time a message was last delivered in a conversation. |
group_id
The ID of the group associated with the conversation. Reference: |
has_attachments
|
preview
|
topic
|
unique_senders
|
conversation_posts
Replication Method : |
Key-based Incremental |
Replication Key |
last_modified_date_time |
Primary Key |
id |
API endpoint : |
The conversation_posts
table contains information about the posts within a conversation thread in your Microsoft account.
id
The post ID. |
|||
last_modified_date_time
The time the post was last modified. |
|||
body
|
|||
categories
|
|||
change_key
|
|||
conversation_id
The conversation ID. Reference: |
|||
created_date_time
|
|||
from
|
|||
has_attachments
|
|||
received_date_time
|
|||
sender
|
|||
thread_id
The ID of the conversation thread associated with the post. Reference: |
conversation_threads
Replication Method : |
Key-based Incremental |
Replication Key |
last_delivered_date_time |
Primary Key |
id |
API endpoint : |
The conversation_threads
table contains information about threads in a group conversation in your Microsoft account.
id
The thread ID. Reference: |
last_delivered_date_time
The time the last message was delivered in the thread. |
conversation_id
The ID of the conversation associated with the thread. Reference: |
group_id
The ID of the group associated with the thread. Reference: |
has_attachments
|
is_locked
|
preview
|
topic
|
unique_senders
|
groups
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The groups
table contains information about groups in your organization within your Microsoft account. Some old teams in your account will not have a resource_provisioning_options
value. For more information, refer to Microsoft’s docs.
id
The group ID. Reference: |
|
classification
|
|
created_date_time
|
|
creation_options
|
|
deleted_date_time
|
|
description
|
|
display_name
|
|
expiration_date_time
|
|
group_types
|
|
is_assignable_to_role
|
|
mail
|
|
mail_enabled
|
|
mail_nickname
|
|
membership_rule
|
|
membership_rule_processing_state
|
|
onPremises_domain_name
|
|
on_premises_last_sync_date_time
|
|
on_premises_net_bios_name
|
|
on_premises_provisioning_errors
|
|
on_premises_sam_account_name
|
|
on_premises_security_identifier
|
|
on_premises_sync_enabled
|
|
preferred_data_location
|
|
preferred_language
|
|
proxy_addresses
|
|
renewed_date_time
|
|
resource_behavior_options
|
|
resource_provisioning_options
|
|
security_edentifier
|
|
security_enabled
|
|
theme
|
|
visibility
|
group_members
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The group_members
table contains information about group members in your Microsoft account. Members can be users, organizational contacts, devices, service principals, and other groups.
id
The group member ID. |
business_phones
|
display_name
|
given_name
|
job_title
|
mail
|
mobile_phone
|
office_location
|
preferred_language
|
surname
|
user_principal_name
|
group_owners
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The group_owners
table contains information about groups’ owners in your Microsoft account. The owners can be a set of users or service principals that have modifying priviliges.
Note: Groups created in Microsoft Exchange will not be available in this table.
id
The group owner ID. |
business_phones
|
display_name
|
given_name
|
group_id
The ID of the group associated with the group owner. Reference: |
job_title
|
mail
|
mobile_phone
|
office_location
|
preferred_language
|
surname
|
user_principal_name
|
team_device_usage_report
Replication Method : |
Key-based Incremental |
Replication Key |
report_refresh_date |
Primary Key |
user_principal_name : report_refresh_date |
API endpoint : |
The team_device_usage_report
table contains information about a group’s device usage in Microsoft Teams.
user_principal_name
The user’s internal identifier in the company’s directory. |
report_refresh_date
The date the report was last refreshed. |
id
|
deleted_date
|
is_deleted
|
last_activity_date
|
report_period
|
used_android_phone
|
used_i_os
|
used_mac
|
used_web
|
used_windows
|
used_windows_phone
|
team_drives
Replication Method : |
Key-based Incremental |
Replication Key |
last_modified_date_time |
Primary Key |
id |
API endpoint : |
The team_drives
table contains information about the drive that your team is on in your Microsoft account.
id
The drive ID. |
|||||
last_modified_date_time
The time the drive was last modified. |
|||||
created_by
|
|||||
drive_type
|
|||||
name
|
|||||
owner
Details about the owner of the team drive.
|
|||||
quota
|
|||||
web_url
|
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The users
table contains information about users in your Microsoft account.
id
The user ID. Reference: |
business_phones
|
display_name
|
given_name
|
job_title
|
mail
|
mobile_phone
|
office_location
|
preferred_language
|
surname
|
user_principal_name
|
Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.