Post a message to Microsoft Teams with bash script.

teams-chat-post-for-workflows.sh

#!/bin/bash
# =============================================================================
#  Author: Chu-Siang Lai / chusiang (at) drx.tw
#  Filename: teams-chat-post-for-workflows.sh
#  Modified: 2024-07-22 11:44 (UTC+08:00)
#  Description: Post a message to Microsoft Teams via "Post to a chat when a webhook request is received" workflows.
#  Reference:
#
#   - https://gist.github.com/chusiang/895f6406fbf9285c58ad0a3ace13d025
#   - https://devblogs.microsoft.com/microsoft365dev/retirement-of-office-365-connectors-within-microsoft-teams/
#   - https://adaptivecards.io/explorer/
#   - https://adaptivecards.io/designer/
#
# =============================================================================

# Help.
if [[ "$1" == "-h" || "$1" == "--help" ]]; then
  echo 'Usage: teams-chat-post.sh "<webhook_url>" "<title>" "<color>" "<message>"'
  exit 0
fi

# Webhook or Token.
WEBHOOK_URL=$1
if [[ "${WEBHOOK_URL}" == "" ]]; then
  echo "No webhook_url specified."
  exit 1
fi
shift

# Title .
TITLE=$1
if [[ "${TITLE}" == "" ]]; then
  echo "No title specified."
  exit 1
fi
shift

# Color.
COLOR=$1
if [[ "${COLOR}" == "" ]]; then
  echo "No color specified."
  exit 1
fi
shift

# Text.
TEXT=$*
if [[ "${TEXT}" == "" ]]; then
  echo "No text specified."
  exit 1
fi

# Escape char: `'`, `"`, `\` .
MESSAGE=$(echo ${TEXT} | sed "s/'/\'/g" | sed 's/"/\"/g; s/\\/\\\\/g')

# Adaptive Cards of TextBlock - https://adaptivecards.io/explorer/TextBlock.html
JSON="{
  \"type\": \"message\",
  \"attachments\": [
    {
      \"contentType\": \"application/vnd.microsoft.card.adaptive\",
      \"contentUrl\": null,
      \"content\": {
        \"$schema\": \"http://adaptivecards.io/schemas/adaptive-card.json\",
        \"type\": \"AdaptiveCard\",
        \"version\": \"1.2\",
        \"body\": [
          {
            \"type\":   \"TextBlock\",
            \"text\":   \"${TITLE}\",
            \"color\":  \"${COLOR}\",
            \"weight\": \"bolder\",
            \"size\":   \"large\",
            \"wrap\":   true
          },
          {
            \"type\":   \"TextBlock\",
            \"text\":   \"${MESSAGE}\",
            \"color\":  \"${COLOR}\",
            \"size\":   \"small\",
            \"wrap\":   true
          }
        ]
      }
    }
  ]
}"

# Post to Microsoft Teams via curl.
curl \
  --header "Content-Type: application/json" \
  --request POST \
  --data "${JSON}" \
  "${WEBHOOK_URL}"

teams-chat-post.sh

#!/bin/bash
# =============================================================================
#  Author: Chu-Siang Lai / chusiang (at) drx.tw
#  Filename: teams-chat-post.sh
#  Modified: 2024-07-12 18:49 (UTC+08:00)
#  Description: Post a message to Microsoft Teams via connectors, not support
#               Power Automate workflows.
#  Reference:
#
#   - https://gist.github.com/chusiang/895f6406fbf9285c58ad0a3ace13d025
#   - https://devblogs.microsoft.com/microsoft365dev/retirement-of-office-365-connectors-within-microsoft-teams/
#   - Fixed for workflows edition: https://gist.github.com/chusiang/895f6406fbf9285c58ad0a3ace13d025?permalink_comment_id=5119162#gistcomment-5119162
#
# =============================================================================

# Help.
if [[ "$1" == "-h" || "$1" == "--help" ]]; then
  echo 'Usage: teams-chat-post.sh "<webhook_url>" "<title>" "<color>" "<message>"'
  exit 0
fi

# Webhook or Token.
WEBHOOK_URL=$1
if [[ "${WEBHOOK_URL}" == "" ]]; then
  echo "No webhook_url specified."
  exit 1
fi
shift

# Title .
TITLE=$1
if [[ "${TITLE}" == "" ]]; then
  echo "No title specified."
  exit 1
fi
shift

# Color.
COLOR=$1
if [[ "${COLOR}" == "" ]]; then
  echo "No status specified."
  exit 1
fi
shift

# Text.
TEXT=$*
if [[ "${TEXT}" == "" ]]; then
  echo "No text specified."
  exit 1
fi

# Convert formating.
MESSAGE=$(echo ${TEXT} | sed 's/"/\"/g' | sed "s/'/\'/g")
JSON="{
  \"title\": \"${TITLE}\",
  \"themeColor\": \"${COLOR}\",
  \"text\": \"${MESSAGE}\"
}"

# Post to Microsoft Teams.
curl -H "Content-Type: application/json" -d "${JSON}" "${WEBHOOK_URL}"

@q2uantum It seems you made an error in de JSON declaration. Could it be you forgot to put \ before the " in your statement. I just saw they are removed in my post above. only the first and the last don't need a \

Screenshot : https://snipboard.io/pdzC3h.jpg

@ronnyheymans Thanks for the quick reply, that fixed the issue 👍

For clarity (if it posts correctly) this is what works:

JSON="{\"type\":\"message\",\"attachments\":[{\"contentType\":\"application/vnd.microsoft.card.adaptive\",\"contentUrl\":null,\"content\":{\"$schema\":\"http://adaptivecards.io/schemas/adaptive-card.json\",\"type\":\"AdaptiveCard\",\"version\":\"1.2\",\"body\":[{\"type\": \"TextBlock\",\"text\": \"${TITLE}\"},{\"type\": \"TextBlock\",\"text\": \"${MESSAGE}\"}]}}]}"

@q2uantum Yep that's how it should be. If you want extra information you can use the designer to add fields and configure how they should look and then copy the json part to the statement here.

@ronnyheymans Do you know if its possible to extend the width of the workflow text box via the JSON script? As its cutting short the test that I used to be able to see via standard Webhook.

I can see in the designer there is a stretch option , would that work in the JSON as a variable ?

@q2uantum You have to enable wrap with "wrap": true on the block you want the complete text. So for example the following
{"type": "TextBlock","wrap": true,"text": "${MESSAGE}"}
I haven't found anything (so far) to enlarge the Adaptive card.

Thanks @ronnyheymans The wrap: true will help me for now. I will keep looking myself for options to enlarge the Adaptive card

If you create a new flow with workflows and change the json structure of the script it works again

create flow with following steps :

• Open Workflows in teams
• +new flow
• choose notifications at the left
• select "Post to a channel when a webhook request is received"
• at the set up your flow part choose the team and channel where you want to post
• create the flow

change ths JSON part in the script to the following : JSON="{"type":"message","attachments":[{"contentType":"application/vnd.microsoft.card.adaptive","contentUrl":null,"content":{"$schema":"http://adaptivecards.io/schemas/adaptive-card.json","type":"AdaptiveCard","version":"1.2","body":[{"type": "TextBlock","text": "${TITLE}"},{"type": "TextBlock","text": "${MESSAGE}"}]}}]}"

More info on the structure of an adaptive card : https://learn.microsoft.com/en-us/adaptive-cards/authoring-cards/getting-started More info on webhook json body structure : https://learn.microsoft.com/en-us/connectors/teams/?tabs=text1#example Adaptive Card designer : https://adaptivecards.io/designer/

Yes, it works.
What about "themeColor": "${COLOR}"? I tried adding this parameter, however, nothing happened.

@whanklee You can add \"color\": \"<options>\"

are:

Default
Dark
Light
Accent
Good
Warning
Attention

@q2uantum Thank you for your share, I can send message to Chat via Workflows now, but I have no permission to send to Channel, so I can't verify it now.

I have put the script of teams-chat-post-for-workflows.sh .

[ [email protected] ~]
$ ./teams-chat-post-for-workflows.sh "https://prod-XXX.weXXXX.logic.azure.com:443/workflows/1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXf/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=BXXXXXXXXXF-fXXXXXXXXXXXXXXXXXXXXXXXXXXXXX4" "Workflows" "Default" "Send from XXXXX-ubuntu."

@chusiang You have a typo in the script :
{ "type": "TextBlock", "text": "${MESSAGE}", "warp": true } should be
{ "type": "TextBlock", "text": "${MESSAGE}", "wrap": true }

@ronnyheymans Thank you for feedback, I have fixed it.

I have leaved a comment to share this new script on Retirement of Office 365 connectors within Microsoft Teams | Microsoft Developer Blogs post, maybe it can help someone.

https://devblogs.microsoft.com/microsoft365dev/retirement-of-office-365-connectors-within-microsoft-teams/comment-page-22/#comment-903

@chusiang thanks for your post, any idea how to get rid of the footnote message "... used a Workflow template to send this card. Get template" and to change the Workflow logo ?

Reference:

• rveachkc/pymsteams#155
• https://github.com/AeroFlorian/MsTeamsAdaptiveCard
• https://github.com/havedill/Zabbix_PowerAutomate
• https://github.com/tlolkema/simple-teams-message
• Microsoft RPA Solution by arksu :: 2022 iThome 鐵人賽

Good news, I can send notification with teams-chat-post-for-workflows.sh to channel via workflows !

https://gist.github.com/chusiang/895f6406fbf9285c58ad0a3ace13d025?permalink_comment_id=5119162#gistcomment-5119162

I guess, it's working now, because I am the owner role in this Teams.

Thanks chusiang , is it possible remove the user name from message ?

Hi @wengzy , I think you need the title like "chusiang via Workflows", I can not see some options for it now.

https://adaptivecards.io/designer/

I'm also successfully using your script to post, but my backend monitoring tool has checks against Windows drive pathing. When those checks pass their data to ${TITLE} or ${MESSAGE} it contains a \ in the drive path. This is breaking the JSON with a "Bad JSON escape sequence: \ . Path 'attachments[0].content.body[1].text" error. I've tried a couple of things to correct this issue, but haven't been able to get around it. Any thoughts?

Hi @lp-maximus,

I think we need add Escape Character for \ on L60 in teams-chat-post-for-workflows.sh.

https://gist.github.com/chusiang/895f6406fbf9285c58ad0a3ace13d025#file-teams-chat-post-for-workflows-sh-L60

I have also escape the \ char, maybe it can help you.

- MESSAGE=$(echo ${TEXT} | sed 's/"/\"/g' | sed "s/'/\'/g")
+ MESSAGE=$(echo ${TEXT} | sed "s/'/\'/g" | sed 's/"/\"/g; s/\\/\\\\/g')

Good luck.

Reference:

1. Which characters need to be escaped when using Bash? | Stack Overflow
2. How to use sed to find and replace text in files in Linux / Unix shell - nixCraft

Chusiang,
Thanks for sharing your script. I was able to look at the JSON you used in your scripts and back-track it to a Microsoft Article that had the working sample JSON for incoming webhooks and most of the requirements for making a successful Adaptive Card post in Teams. There are a lot of samples for AdaptiveCard from Microsoft articles that do not work as-is in Teams. They must have the required bits from the article The JSON in the incoming webhook section below is the only JSON formatting that's been successful so far for me.

https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/connectors-using?tabs=cURL%2Ctext1#send-adaptive-cards-using-an-incoming-webhook

In combination with using the "body" sections of the samples from AdaptiveCards.io, I've made a lot of progress in posting various types of messages with different formatting. The examples that used data binding don't seem to be supported in Teams. The article above also calls out the elements in the schema that are and are not supported.

Additionally, for those using GitLab the webhooks work from there if the workflow accepts POSTS from "anyone"

@chusiang,
Your code changes worked great for me, much appreciated.

@chusiang thanks for your post, any idea how to get rid of the footnote message "... used a Workflow template to send this card. Get template" and to change the Workflow logo ?

You can remove the message by copying the Workflows to a new one. A new webhook url will be created. I have the original one turned off.

Additionally, if you create the workflow without using a template, the footer advertisement for templates won’t be present. I think it’s there to promote the use of workflow templates to save time. You can assemble the same components that are in the template and not have to worry about the footer advertisement.

Thanks for feedback from @cowbe0x004 and @ehouston3 ,
I have tried to remove the footer, but something is working and something not.

If we want to stop show (or remove) the footer:

1. Manual create the workflows, not from template. #gistcomment-5131921
2. Clone the working one from template, and use the new one. #gistcomment-5131697

I think the answer is clean now.

CC @zeyt27

This is beautiful. Thank you!

How to send a message on Microsoft teams with new line character? With \n not working. What should I use?

Hi @whanklee , please try \n\n, it's working on https://adaptivecards.io/designer .

{
  "type": "TextBlock",
  "text": "It doesn't wrap by\n\n default",
  "weight": "bolder"
},

Hi @chusiang,
\r\n\r\n works well.

Hi @lp-maximus,

I think we need add Escape Character for \ on L60 in teams-chat-post-for-workflows.sh.

https://gist.github.com/chusiang/895f6406fbf9285c58ad0a3ace13d025#file-teams-chat-post-for-workflows-sh-L60

I have also escape the \ char, maybe it can help you.

- MESSAGE=$(echo ${TEXT} | sed 's/"/\"/g' | sed "s/'/\'/g")
+ MESSAGE=$(echo ${TEXT} | sed "s/'/\'/g" | sed 's/"/\"/g; s/\\/\\\\/g')

Good luck.

Reference:

1. Which characters need to be escaped when using Bash? | Stack Overflow
2. How to use sed to find and replace text in files in Linux / Unix shell - nixCraft

Hi,

In my case I'm passing to the script an output of another script, which takes sql query result and concats with another line having an escaped newline:
query-db-and-pass-to-teams-script.sh
MESSAGE="$SQL_RESULT" # Which is a 5 line string, 1st 4 ending with literal newlines.
MESSAGE+="\nAnother line here"
${TEAMS_SCRIPT} "$WEBHOOK_URL" "$TITLE" "$COLOR" "$MESSAGE"

So when this $MESSAGE is passed to your script, several issues occur at this line:
MESSAGE=$(echo ${TEXT} | sed "s/'/\'/g" | sed 's/"/\"/g; s/\\/\\\\/g')

1. If we use echo ${TEXT} - it will eat all literal newlines. Had to use echo "${TEXT}" to avoid that.
2. s/\/\\/g turns my concated escaped newline in "\nAnother line here" into "\\\\nAnother line here"

P.S.
echo "No status specified."
Was it meant "No color specified."?

Hi @alaxelmck,

I have update to No color specified., it's typo with I copy from my old script like slack-chat-post.sh .

About support output of another script part, I have no idea now.