How to use @mention

[fc-ds]

Hello,

I'm trying to mention someone in the cards like I do manually with @user .

Is there a way to do that with this lib ?

[atc0005]

@fc-ds I do not believe that mentioning someone via incoming webhooks is permitted by Microsoft Teams. At least, it wasn't when I last looked into the support for it.

I don't have the original references I looked at available to cite, but I specifically recall looking into this in the past and found it wasn't an option.

If you find that this is now supported via Incoming Webhooks, please share those details so we can look further into it. It would be useful to have that support in this library.

[ghokun]

You can mention someone with following:

curl -X POST -H "Content-type: application/json" -d '{
    "type": "message", 
    "text": "Hey <at>Some User</at> check out this message",
    "entities": [
        {
            "type":"mention",
            "mentioned":{
                "id":"some.user@company.com",
                "name":"Some User"
            },
            "text": "<at>Some User</at>"
        }
    ]
}' <webhook_url>

[atc0005]

@ghokun thanks for sharing!

[atc0005]

@fc-ds Thanks to the feedback from @ghokun, we now know that this (much requested) feature is available in Microsoft Teams.

I'll first prototype the support in a small project that I maintain which uses this library, then land the applicable changes here. No estimates for when that will be, but I'll be sure to let you know when it does.

Thanks for opening this issue and your interest.

[atc0005]

@ghokun: You can mention someone with following:

curl -X POST -H "Content-type: application/json" -d '{
    "type": "message", 
    "text": "Hey <at>Some User</at> check out this message",
    "entities": [
        {
            "type":"mention",
            "mentioned":{
                "id":"some.user@company.com",
                "name":"Some User"
            },
            "text": "<at>Some User</at>"
        }
    ]
}' <webhook_url>

As previously noted, this example works as intended. However, I'm having some trouble finding a good reference for the JSON format.

This doesn't appear to be the legacy MessageCard format or the Adaptive Card format, but potentially the format noted here:

https://docs.microsoft.com/en-us/microsoftteams/platform/bots/how-to/conversations/channel-and-group-conversations?tabs=json#add-mentions-to-your-messages

If this library implements the Adaptive Card format, the desired mention support would be provided, but the JSON snippet you provided appears to be much simpler. If this library implements support for that format, the desired functionality can be added sooner.

I expect that I'm overlooking it, but if you happen to have a reference to share that would be appreciated.

[ghokun]

I was looking for a way to mention user names when a pull request is opened on gitlab through gitlab-teams integration. I was not successful but saw this repository. I think this message format is for bot api but works in webhooks regardless.

There is a website for designing adaptive cards : https://adaptivecards.io/designer/
I spent some time there but could not get mentions to work with adaptive cards.

[atc0005]

@fc-ds

Initial support available here:

https://github.com/atc0005/go-teams-notify/releases/tag/v2.7.0-alpha.1

Example here:

go-teams-notify/examples/user-mention/main.go

Lines 35 to 58 in 2b9b721

	// init the client
	mstClient := goteamsnotify.NewTeamsClient()
	webhookUrl := "https://outlook.office.com/webhook/YOUR_WEBHOOK_URL_OF_TEAMS_CHANNEL"
	// setup message
	msg := botapi.NewMessage().AddText("Hello there!")
	// add user mention
	if err := msg.Mention("John Doe", "jdoe@example.com", true); err != nil {
	fmt.Printf(
	"failed to add user mention: %v",
	err,
	)
	}
	// send message
	if err := mstClient.Send(webhookUrl, msg); err != nil {
	fmt.Printf(
	"failed to send message: %v",
	err,
	)
	os.Exit(1)
	}

Feedback is welcome.

This is a pretty limited implementation; a more complete implementation is planned for a future release once Adaptive Card support is added. This upcoming release is intended to lay the foundation for that future support.

[atc0005]

@fc-ds

Initial support available here:

https://github.com/atc0005/go-teams-notify/releases/tag/v2.7.0-alpha.1

Example here:

go-teams-notify/examples/user-mention/main.go

Lines 35 to 58 in 2b9b721

	// init the client
	mstClient := goteamsnotify.NewTeamsClient()
	webhookUrl := "https://outlook.office.com/webhook/YOUR_WEBHOOK_URL_OF_TEAMS_CHANNEL"
	// setup message
	msg := botapi.NewMessage().AddText("Hello there!")
	// add user mention
	if err := msg.Mention("John Doe", "jdoe@example.com", true); err != nil {
	fmt.Printf(
	"failed to add user mention: %v",
	err,
	)
	}
	// send message
	if err := mstClient.Send(webhookUrl, msg); err != nil {
	fmt.Printf(
	"failed to send message: %v",
	err,
	)
	os.Exit(1)
	}

Feedback is welcome.

This is a pretty limited implementation; a more complete implementation is planned for a future release once Adaptive Card support is added. This upcoming release is intended to lay the foundation for that future support.

Initial Adaptive Card support has been added as of this release:

https://github.com/atc0005/go-teams-notify/releases/tag/v2.7.0-alpha.2

Feedback is very much encouraged so issues can be found/resolved before the stable v2.7.0 release (date TBD). Discussion thread here: #163

The botapi package intended as temporary support for user mentions has been removed as the generated payloads have been found to be intermittently rejected by the Teams API (atc0005/send2teams#225).

Examples for the new package can be found here:

https://github.com/atc0005/go-teams-notify/tree/master/examples/adaptivecard

An equivalent example for what I provided previously:

go-teams-notify/examples/adaptivecard/user-mention-single/main.go

Lines 37 to 65 in b24de89

	func main() {
	// Initialize a new Microsoft Teams client.
	mstClient := goteamsnotify.NewTeamsClient()
	// Set webhook url.
	webhookUrl := "https://outlook.office.com/webhook/YOUR_WEBHOOK_URL_OF_TEAMS_CHANNEL"
	// Setup empty message.
	msg := adaptivecard.NewMessage()
	// Add user mention and specified text.
	if err := msg.Mention(true, "John Doe", "jdoe@example.com", "Hello there!"); err != nil {
	log.Printf(
	"failed to add user mention: %v",
	err,
	)
	os.Exit(1)
	}
	// Send the message with default timeout/retry settings.
	if err := mstClient.Send(webhookUrl, msg); err != nil {
	log.Printf(
	"failed to send message: %v",
	err,
	)
	os.Exit(1)
	}
	}

Thanks for your interest in this project.

[atc0005]

No negative feedback has been received for the v2.7.0-alpha.2 release thus far.

I'm considering this resolved for the v2.7.0 release.