Skip to content

Teams

New webhook URL format only

Shoutrrr now only supports the new Teams webhook URL format with an organization-specific domain.

You must specify your organization domain using:

?host=example.webhook.office.com
Where example is your organization's short name.

Legacy webhook formats (e.g., outlook.office.com) are no longer supported.

URL Format

teams://group@tenant/altId/groupOwner/extraId?host=organization.webhook.office.com[&color=color][&title=title]

Where:

  • group: The first UUID component from the webhook URL.
  • tenant: The second UUID component from the webhook URL.
  • altId: The third component (hex string) from the webhook URL.
  • groupOwner: The fourth UUID component from the webhook URL.
  • extraId: The fifth component at the end of the webhook URL.
  • organization: Your organization name for the webhook domain (required).
  • color: Optional hex color code for the message card (e.g., FF0000 for red).
  • title: Optional title for the message card.

URL Fields

  • Group
    Default: empty
    URL part: teams://group@tenant/altid/groupowner/extraid
  • Tenant
    Default: empty
    URL part: teams://group@tenant/altid/groupowner/extraid
  • AltID
    Default: empty
    URL part: teams://group@tenant/altid/groupowner/extraid
  • GroupOwner
    Default: empty
    URL part: teams://group@tenant/altid/groupowner/extraid
  • ExtraID
    Default: empty
    URL part: teams://group@tenant/altid/groupowner/extraid

Query/Param Props

Props can be either supplied using the params argument, or through the URL using
?key=value&key=value etc.

  • Color
    Default: empty

  • Host
    Default: empty

  • Title
    Default: empty

Setting up a webhook

To use the Microsoft Teams notification service, you need to set up a custom incoming webhook. Follow the instructions in this Microsoft guide.

Extracting the token

The token is extracted from your webhook URL:

https://<organization>.webhook.office.com/webhookb2/<group>@<tenant>/IncomingWebhook/<altId>/<groupOwner>/<extraId>

Important components

All parts of the webhook URL are required:

  • organization: Your organization name (e.g., contoso).
  • group: First UUID component.
  • tenant: Second UUID component.
  • altId: Third component (hex string).
  • groupOwner: Fourth UUID component.
  • extraId: Fifth component.

Example

# Original webhook URL:
https://contoso.webhook.office.com/webhookb2/11111111-4444-4444-8444-cccccccccccc@22222222-4444-4444-8444-cccccccccccc/IncomingWebhook/33333333012222222222333333333344/44444444-4444-4444-8444-cccccccccccc/V2ESyij_gAljSoUQHvZoZYzlpAoAXExyOl26dlf1xHEx05

# Shoutrrr URL:
teams://11111111-4444-4444-8444-cccccccccccc@22222222-4444-4444-8444-cccccccccccc/33333333012222222222333333333344/44444444-4444-4444-8444-cccccccccccc/V2ESyij_gAljSoUQHvZoZYzlpAoAXExyOl26dlf1xHEx05?host=contoso.webhook.office.com&color=FF0000&title=Alert

In this example:

  • color=FF0000 sets a red theme.
  • title=Alert adds a custom title to the message card.