[Teams] Send Message
Q100071: [Teams] Send Message
Send a message to a Microsoft Teams channel
Parameter | In/Out | Description | Other Info |
---|---|---|---|
Channel Webhook URL | In | Microsoft Teams Channel Webhook URL. | |
Message | In | Text of message to post on the channel. |
(Italics = required parameters)
Notes
The [Teams] Send Message
module uses the Microsoft Teams webhook API for communications. This means that it can be setup in a manner that it does not use specific accounts for authentication or communication. You just create the connection for it in your Teams Client
and this will provide you with the valid Webhook URL
that it needs. It allows any job to be able to send messages to any channel in your Teams organization.
About Webhooks in Microsoft Teams
To create a new Webhook URL
for use with this module, we will outline the steps below. It is easy to follow, but since updates to the Microsoft Teams client happen regularly, there may be some slight changes, but you should be able to still follow these basic steps. Of course, if there are major changes to the Teams Client, we will provide updated information. Each channel in Teams that you want to be able to send messages to, will require a webhook that is unique to that channel. Therefore if there are multiple different channels you wish to send messages to, you will need to create a separate webhook for each one of those channels.
In addition to that, you also would be able to define multiple webhooks for the same channel. Since each webhook can have its own unique name and a custom image defined for it, you can define the appearance of the messages as coming from unique entities. Thus you could use this technique to have all of your jobs send message to a single channel for monitoring, but you might define unique webhooks to represent different meanings for your end users.
Creating a new Teams Webhook URL for your Teams Channel
Open your regular Microsoft Teams client and navigate to the channel you what to communicate with.
Normally, it should default to opening the Posts tab, so make certain that is what you have selected.
In the top right corner is the
more options (...)
menu, select that.From the more options drop down menu, find the
Connectors
option.Once the list of connectors is visible, look for the
Incoming Webhook
connector. If it has anAdd
button next to it, it has not yet been installed for the group that this channel belongs to. Go ahead and clickAdd
.Once the
Incoming Webhook
connector is added, then you should now see aConfigure
button next to it, click this to setup your first connector.The webhook will need a name. Enter an appropriate name for your webhook. Note that since each webhook is unique to each channel in Teams, you might want to use a name corresponding to the channel.
You can optionally add a custom image to associate with any message posts into the channel via the webhook. This shows up just like the avatar image a user may have defined for their personal account.
When ready, click the
Create
button and it should generate the webhook and will display the URL to use for the webhook. Hit thecopy
button next to the webhook URL and clickDone
.When configuring the
[Teams] Send Message
module, you will paste thisWebhook URL
into the correspnding parameter in the module.