Skip to content

Latest commit

 

History

History
244 lines (183 loc) · 9.99 KB

README.md

File metadata and controls

244 lines (183 loc) · 9.99 KB
Raw

go-teams-notify

A package to send messages to Microsoft Teams (channels)

Latest release Go Reference License Validate Codebase Validate Docs Lint and Build using Makefile Quick Validation

Table of contents

Project home

See our GitHub repo for the latest code, to file an issue or submit improvements for review and potential inclusion into the project.

Overview

The goteamsnotify package (aka, go-teams-notify) allows sending messages to a Microsoft Teams channel.

Simple messages can be composed of only a title and a text body. More complex messages can be composed of multiple sections, key/value pairs (aka, Facts) and/or externally hosted images. See the Features list for more information.

Features

  • Submit simple or complex messages to Microsoft Teams
    • simple messages consist of only a title and a text body (one or more strings)
    • complex messages consist of one or more sections, key/value pairs (aka, Facts) and/or externally hosted images. or images (hosted externally)
  • Support for Actions, allowing users to take quick actions within Microsoft Teams
  • Configurable validation of webhook URLs
    • enabled by default, attempts to match most common known webhook URL patterns
    • option to disable validation entirely
    • option to use custom validation patterns
  • Configurable validation of MessageCard type
    • default assertion that bare-minimum required fields are present
    • support for providing a custom validation function to override default validation behavior
  • Configurable timeouts
  • Configurable retry support
  • Support for overriding the default http.Client

Project Status

In short:

  • The upstream project is no longer being actively developed or maintained.
  • This fork is now a standalone project, accepting contributions, bug reports and feature requests.
  • Others have also taken an interest in maintaining their own forks of the original project. See those forks for other ideas/changes that you may find useful.

For more details, see the Releases section or our Changelog.

Supported Releases

Series Example Status
v1.x.x v1.3.1 Not Supported (EOL)
v2.x.x v2.6.0 Supported

Changelog

See the CHANGELOG.md file for the changes associated with each release of this application. Changes that have been merged to master, but not yet an official release may also be noted in the file under the Unreleased section. A helpful link to the Git commit history since the last official release is also provided for further review.

Usage

Add this project as a dependency

Assuming that you're using Go Modules, add this line to your imports like so:

import (
  // ...

  "github.com/atc0005/go-teams-notify/v2"
)

Depending on your editor and current settings, your editor may resolve the import and update your go.mod and go.sum files accordingly. If not, review these resources for further information:

See the Examples section for more details.

Webhook URLs

Expected format

Valid webhook URLs for Microsoft Teams use one of several (confirmed) FQDNs patterns:

  • outlook.office.com
  • outlook.office365.com
  • *.webhook.office.com
    • e.g., example.webhook.office.com

Using a webhook URL with any of these FQDN patterns appears to give identical results.

Here are complete, equivalent example webhook URLs from Microsoft's documentation using the FQDNs above:

All of these patterns when provided to this library should pass the default validation applied. See the example further down for the option of disabling webhook URL validation entirely.

How to create a webhook URL (Connector)

  1. Open Microsoft Teams
  2. Navigate to the channel where you wish to receive incoming messages from this application
  3. Select ⋯ next to the channel name and then choose Connectors.
  4. Scroll through the list of Connectors to Incoming Webhook, and choose Add.
  5. Enter a name for the webhook, upload an image to associate with data from the webhook, and choose Create.
  6. Copy the webhook URL to the clipboard and save it. You'll need the webhook URL for sending information to Microsoft Teams.
    • NOTE: While you can create another easily enough, you should treat this webhook URL as sensitive information as anyone with this unique URL is able to send messages (without authentication) into the associated channel.
  7. Choose Done.

Credit: docs.microsoft.com, gist comment from shadabacc3934

Examples

Basic

This is an example of a simple client application which uses this library.

File: basic

Add an Action

This example illustrates adding an OpenUri Action to a message card. When used, this action triggers opening a URI in a separate browser or application.

File: actions

Disable webhook URL prefix validation

This example disables the validation webhook URLs, including the validation of known prefixes so that custom/private webhook URL endpoints can be used (e.g., testing purposes).

File: disable-validation

Enable custom patterns' validation

This example demonstrates how to enable custom validation patterns for webhook URLs.

File: custom-validation

Used by

See the Known importers lists below for a dynamically updated list of projects using either this library or the original project.

References