Skip to main content

Microsoft Teams Integration

To configure Microsoft Teams notifications, follow these simple steps:

1. Create an Incoming Webhook​

Microsoft Teams uses incoming webhooks to receive messages from external services. Here's how to set one up:

  • Go to your Microsoft Teams channel where you want to receive notifications.
  • Click on the three dots (⋯) next to the channel name.
  • Select Connectors from the menu.
  • Search for Incoming Webhook and click Configure.
  • Give your webhook a name (e.g., "Build Notifier") and optionally upload an image.
  • Click Create.
  • Copy the webhook URL that is generated (you won't be able to see it again).
Important

Make sure to copy the webhook URL immediately, as you won't be able to view it again after closing the dialog. If you lose it, you'll need to create a new webhook.

Note: Checkout official Microsoft Teams documentation for detailed walkthrough.

2. Set Up Your Project​

Once you have your webhook URL, add it to your config.yaml:

teams:
  enabled: true
  webhook_url: YOUR_WEBHOOK_URL # Required: Microsoft Teams Incoming Webhook URL
  share_QR: true # Optional: Share QR code in Teams (default: true)
  share_link: true # Optional: Share build download link in Teams (default: true)
  custom_message: "🚀 Check out the latest build! Download your app now!" # Optional: Custom message
  mention_users: ["John Doe", "Jane Smith"] # Optional: List of user names to include in message

3. Get User Names for Mentions (Optional)​

If you want to include user names in your Teams notifications:

  • In Microsoft Teams, you can include user display names in the message.
  • Important: Teams webhooks don't support actual @mentions. User names will be included as plain text in the message.
  • Add user display names to the mention_users list in your configuration.
  • They will appear as "Mentioning: John Doe, Jane Smith" in the message.
Limitations

Microsoft Teams webhooks use Adaptive Cards for rich message formatting. The QR code will be embedded as a base64 image in the card. For actual @mentions, you would need to use the Microsoft Graph API or Bot Framework, which is beyond the scope of simple webhook integration.

4. Configuration Options​

KeyDescriptionRequiredExample
enabledEnable Microsoft Teams notificationsYestrue
webhook_urlMicrosoft Teams Incoming Webhook URLYesGet from Teams channel connectors
share_QRWhether to share QR code in TeamsNotrue (default)
share_linkWhether to share build download link in TeamsNotrue (default)
custom_messageCustom message to share with the build linkNo"🚀 Check out the latest build! Download your app now!"
mention_usersList of Teams user names to include in messageNo["John Doe", "Jane Smith"] (Note: Webhooks don't support @mentions, names will be shown as plain text)

5. Testing Your Configuration​

After setting up your Teams webhook:

  1. Make sure enabled: true is set in your config.
  2. Run a build command: 
    frx build
  3. Check your Teams channel for the notification with the build link and QR code.

Troubleshooting​

Webhook URL Not Working​

  • Verify the webhook URL is correct and hasn't been revoked.
  • Check that the webhook is still active in your Teams channel connectors.
  • Ensure the URL starts with https:// and is complete.

Messages Not Appearing​

  • Verify enabled: true is set in your configuration.
  • Check that the webhook URL is valid and active.
  • Ensure your build process completed successfully (Teams notifications are sent after successful builds).

QR Code Not Displaying​

  • Teams webhooks support images via Adaptive Cards.
  • The QR code is embedded as a base64 image.
  • If the QR code doesn't appear, check that share_QR: true is set.
💡 Pro Tip

You can use the same webhook URL for multiple channels by creating separate webhooks for each channel. Each webhook URL is unique to its channel.