diff --git a/docs/integrations/README.md b/docs/integrations/README.md index 7ec5e0e..e0a1bdf 100644 --- a/docs/integrations/README.md +++ b/docs/integrations/README.md @@ -18,6 +18,7 @@ Orb can integrate with various third-party applications and services to display - [OpenAI Codex](/docs/integrations/codex.md) - [Copilot Studio](/docs/integrations/copilot.md) - [OpenCode](/docs/integrations/opencode.md) +- [Microsoft Teams](/docs/integrations/microsoft-teams.md) - [Elgato Stream Deck](/docs/integrations/stream-deck.md) ## Integration Support diff --git a/docs/integrations/microsoft-teams.md b/docs/integrations/microsoft-teams.md new file mode 100644 index 0000000..5276f2e --- /dev/null +++ b/docs/integrations/microsoft-teams.md @@ -0,0 +1,84 @@ +--- +title: Orb for Microsoft Teams +shortTitle: Microsoft Teams +metaDescription: Send Orb Event alerts to a Microsoft Teams channel. +section: Integrations +layout: guides +subtitle: 'Difficulty: Beginner 🧑‍💻' +--- + +# Orb for Microsoft Teams + +The Microsoft Teams integration posts a notification to a Teams channel whenever an Orb Event is triggered. Connect Orb Cloud to a Teams channel using an incoming webhook, then point one or more of your Event Destinations at it to keep your team informed about connectivity and performance changes without leaving Teams. + +![An Orb Event notification in a Microsoft Teams channel](../../images/integrations/teams-event-notification.png) + +## How it works + +Microsoft Teams provides an incoming webhook URL through its built-in Workflows. When you create a Microsoft Teams Destination in Orb Cloud and paste in that webhook URL, any Event configured to use the Destination will post a message to the channel with the details of what was triggered. + +## Requirements + +- A Microsoft Teams account with permission to add Workflows to a channel +- Access to [Orb Cloud](https://cloud.orb.net) with permission to manage Events & Alerts + +## Step 1: Create a webhook in Microsoft Teams + +### Open the channel's Workflows + +1. Open the Teams channel where you want messages to appear. +2. Click the **…** (More options) next to the channel. +3. Select **Workflows**. + +![Selecting Workflows from the channel's more options menu](../../images/integrations/teams-channel-workflows.png) + +### Add the webhook workflow + +4. Search for **webhook** and select **Send webhook alerts to a channel**. + +![Searching for the webhook workflow template](../../images/integrations/teams-webhook-template.png) + +5. Fill out the parameters, confirming the correct **Team** and **Channel** are selected, then click **Save**. + +![Configuring the webhook workflow parameters](../../images/integrations/teams-webhook-parameters.png) + +### Copy the webhook link + +6. Click **Copy webhook link**. Keep this URL handy — you'll paste it into Orb Cloud in the next step. + +![Copying the generated webhook link](../../images/integrations/teams-copy-webhook-link.png) + +:::warning +Treat the webhook URL like a secret. Anyone with the URL can post messages to your channel. +::: + +## Step 2: Create the Destination in Orb Cloud + +1. In Orb Cloud, create a new Destination of type **Microsoft Teams**. See the [Events & Alerts documentation](/docs/orb-cloud/events-alerts#creating-and-managing-rule-alert-desinations) for details on managing Destinations. +2. Give the Destination a descriptive name. +3. Paste the webhook link you copied from Teams into the **Teams Webhook URL** field, then save. + +![Creating a Microsoft Teams Destination in Orb Cloud](../../images/integrations/teams-orb-destination.png) + +## Step 3: Configure an Event + +Configure an Event as described in the [Events & Alerts documentation](/docs/orb-cloud/events-alerts) and select the Microsoft Teams Destination you just created. The next time that Event triggers, a notification will be posted to your Teams channel. + +## Troubleshooting + +### Messages aren't arriving in Teams + +- Confirm the workflow is set to **Active** in the Teams Workflows panel. +- Verify the webhook URL was copied in full and pasted into the Orb Cloud Destination without extra spaces. +- Make sure the Event is enabled and the Microsoft Teams Destination is selected on the rule. + +### The webhook stopped working + +Teams webhook URLs can expire or be revoked. If messages stop arriving, re-open the channel's Workflows, copy a fresh webhook link, and update the URL on your Orb Cloud Destination. + +## Support + +For additional help with the Microsoft Teams integration: + +- Join our [Discord community](https://discord.gg/orbforge) +- [Contact the Orb team](https://orb.net/contact) diff --git a/images/integrations/teams-channel-workflows.png b/images/integrations/teams-channel-workflows.png new file mode 100644 index 0000000..1f8fc9d Binary files /dev/null and b/images/integrations/teams-channel-workflows.png differ diff --git a/images/integrations/teams-copy-webhook-link.png b/images/integrations/teams-copy-webhook-link.png new file mode 100644 index 0000000..d24018c Binary files /dev/null and b/images/integrations/teams-copy-webhook-link.png differ diff --git a/images/integrations/teams-event-notification.png b/images/integrations/teams-event-notification.png new file mode 100644 index 0000000..4a56f59 Binary files /dev/null and b/images/integrations/teams-event-notification.png differ diff --git a/images/integrations/teams-orb-destination.png b/images/integrations/teams-orb-destination.png new file mode 100644 index 0000000..cb9f8d1 Binary files /dev/null and b/images/integrations/teams-orb-destination.png differ diff --git a/images/integrations/teams-webhook-parameters.png b/images/integrations/teams-webhook-parameters.png new file mode 100644 index 0000000..d4dcf40 Binary files /dev/null and b/images/integrations/teams-webhook-parameters.png differ diff --git a/images/integrations/teams-webhook-template.png b/images/integrations/teams-webhook-template.png new file mode 100644 index 0000000..c4a6e1f Binary files /dev/null and b/images/integrations/teams-webhook-template.png differ diff --git a/navigation.md b/navigation.md index 6195741..d8bbd1d 100644 --- a/navigation.md +++ b/navigation.md @@ -85,6 +85,7 @@ - [OpenAI Codex](/docs/integrations/codex.md) - [Copilot Studio](/docs/integrations/copilot.md) - [OpenCode](/docs/integrations/opencode.md) +- [Microsoft Teams](/docs/integrations/microsoft-teams.md) - [Elgato Stream Deck](/docs/integrations/stream-deck.md) ## [Sensorbox](/docs/sensorbox)