Google Chat - Send message | Octopus Integrations

Octopus.Script exported 2024-04-03 by harrisonmeister belongs to ‘Google Chat’ category.

Send a message to a Google Chat space using a configured chat webhook.

Multi-line message content and basic formatting are supported.

Note: This script is written in python, and is required for this step to function correctly.

Parameters

When steps based on the template are included in a project’s deployment process, the parameters below can be set.

Webhook URL

GoogleChat.SendMessage.WebhookUrl =

Provide the Google Chat Webhook URL

Message Content

GoogleChat.SendMessage.MessageContent =

Provide the message to send. Multi-line values, and basic formatting are supported.

Script body

Steps based on this template will execute the following Python script.

import subprocess
import sys

subprocess.check_call([sys.executable, '-m', 'pip', 'install', 'httplib2', '--disable-pip-version-check'])

# parameters
webhook_url = get_octopusvariable("GoogleChat.SendMessage.WebhookUrl")
message_content = get_octopusvariable("GoogleChat.SendMessage.MessageContent")

if not webhook_url:
  raise ValueError('Webhook url null or empty!')
  
if not message_content:
  raise ValueError('Message content null or empty!')
  
from json import dumps
from httplib2 import Http

app_message = {"text": message_content}
message_headers = {"Content-Type": "application/json; charset=UTF-8"}
http_obj = Http()
response = http_obj.request(
  uri=webhook_url,
  method="POST",
  headers=message_headers,
  body=dumps(app_message),
)
printverbose('Google response:')
printverbose(response)

Provided under the Apache License version 2.0.

Report an issue

To use this template in Octopus Deploy, copy the JSON below and paste it into the Library → Step templates → Import dialog.

{
  "Id": "6c4c6253-45de-404f-b725-c96e1d7e4958",
  "Name": "Google Chat - Send message",
  "Description": "Send a message to a [Google Chat](https://chat.google.com) space using a configured [chat webhook](https://developers.google.com/workspace/chat/quickstart/webhooks#python_2).\n\nMulti-line message content and [basic formatting](https://developers.google.com/workspace/chat/format-messages) are supported.\n\n**Note:** This script is written in python, and is required for this step to function correctly.",
  "Version": 1,
  "ExportedAt": "2024-04-03T13:02:57.192Z",
  "ActionType": "Octopus.Script",
  "Author": "harrisonmeister",
  "Packages": [],
  "Parameters": [
    {
      "Id": "bb5767eb-bbfb-4379-917e-31f73cf56ad2",
      "Name": "GoogleChat.SendMessage.WebhookUrl",
      "Label": "Webhook URL",
      "HelpText": "Provide the Google Chat [Webhook URL](https://developers.google.com/workspace/chat/quickstart/webhooks)",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "Sensitive"
      }
    },
    {
      "Id": "cb6577d7-d160-4e3a-86ea-b536bf92133a",
      "Name": "GoogleChat.SendMessage.MessageContent",
      "Label": "Message Content",
      "HelpText": "Provide the message to send. Multi-line values, and [basic formatting](https://developers.google.com/workspace/chat/format-messages) are supported.",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "MultiLineText"
      }
    }
  ],
  "Properties": {
    "Octopus.Action.Script.ScriptSource": "Inline",
    "Octopus.Action.Script.Syntax": "Python",
    "Octopus.Action.Script.ScriptBody": "import subprocess\nimport sys\n\nsubprocess.check_call([sys.executable, '-m', 'pip', 'install', 'httplib2', '--disable-pip-version-check'])\n\n# parameters\nwebhook_url = get_octopusvariable(\"GoogleChat.SendMessage.WebhookUrl\")\nmessage_content = get_octopusvariable(\"GoogleChat.SendMessage.MessageContent\")\n\nif not webhook_url:\n  raise ValueError('Webhook url null or empty!')\n  \nif not message_content:\n  raise ValueError('Message content null or empty!')\n  \nfrom json import dumps\nfrom httplib2 import Http\n\napp_message = {\"text\": message_content}\nmessage_headers = {\"Content-Type\": \"application/json; charset=UTF-8\"}\nhttp_obj = Http()\nresponse = http_obj.request(\n  uri=webhook_url,\n  method=\"POST\",\n  headers=message_headers,\n  body=dumps(app_message),\n)\nprintverbose('Google response:')\nprintverbose(response)"
  },
  "Category": "Google Chat",
  "HistoryUrl": "https://github.com/OctopusDeploy/Library/commits/master/step-templates//opt/buildagent/work/75443764cd38076d/step-templates/google-chat-send-message.json",
  "Website": "/step-templates/6c4c6253-45de-404f-b725-c96e1d7e4958",
  "Logo": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADOCAYAAAB7AU2DAAAAxHpUWHRSYXcgcHJvZmlsZSB0eXBlIGV4aWYAAHjabVBbDgMhCPz3FD2CPGTxOO6jSW/Q4xcFm91uJ3FAxoxAOt6vZ3p0IHDisqhUkWzgyhWbJZodbTBkHjywTQ2u9bQdIaCVyCL5VSXezzp8DTw0y8rJSLcQ1qtQOfz1xwg9UO+o53sY1TAidAHCoPlYWaou5xHWOcGE+kmdWK9t3+6LbW8v9g8hHgSUjYnEG6B+OFGzhAejPQQSy4GKMROGmS3k354m0ge+OFmqJ9OD5wAAAYRpQ0NQSUNDIHByb2ZpbGUAAHicfZE9SMNAHMVf00pFWjrYQcQhQ3VqQVTEUatQhAqhVmjVweTSL2jSkqS4OAquBQc/FqsOLs66OrgKguAHiLODk6KLlPi/pNAixoPjfry797h7BwitKtPMwDig6ZaRSSXFXH5VDL4iAAERhBGXmVmfk6Q0PMfXPXx8vUvwLO9zf46wWjAZ4BOJZ1ndsIg3iKc3rTrnfeIoK8sq8Tlx3KALEj9yXXH5jXPJYYFnRo1sZp44SiyWeljpYVY2NOIp4piq6ZQv5FxWOW9x1qoN1rknf2GooK8sc53mCFJYxBIkiFDQQAVVWEjQqpNiIkP7SQ//sOOXyKWQqwJGjgXUoEF2/OB/8Ltbszg54SaFkkDfi21/jALBXaDdtO3vY9tunwD+Z+BK7/prLWDmk/RmV4sdAZFt4OK6qyl7wOUOMPRUlw3Zkfw0hWIReD+jb8oDg7fAwJrbW2cfpw9AlrpK3wAHh8BYibLXPd7d39vbv2c6/f0ANtNyjxywc3cAAA14aVRYdFhNTDpjb20uYWRvYmUueG1wAAAAAAA8P3hwYWNrZXQgYmVnaW49Iu+7vyIgaWQ9Ilc1TTBNcENlaGlIenJlU3pOVGN6a2M5ZCI/Pgo8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIiB4OnhtcHRrPSJYTVAgQ29yZSA0LjQuMC1FeGl2MiI+CiA8cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPgogIDxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiCiAgICB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIKICAgIHhtbG5zOnN0RXZ0PSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VFdmVudCMiCiAgICB4bWxuczpkYz0iaHR0cDovL3B1cmwub3JnL2RjL2VsZW1lbnRzLzEuMS8iCiAgICB4bWxuczpHSU1QPSJodHRwOi8vd3d3LmdpbXAub3JnL3htcC8iCiAgICB4bWxuczp0aWZmPSJodHRwOi8vbnMuYWRvYmUuY29tL3RpZmYvMS4wLyIKICAgIHhtbG5zOnhtcD0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLyIKICAgeG1wTU06RG9jdW1lbnRJRD0iZ2ltcDpkb2NpZDpnaW1wOmJkY2YzM2U0LTA5MDQtNGQ4Yy04N2JjLTdmY2YxYjk1OTg4MCIKICAgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDo1ZjI5YzYyNi1kNTFjLTQ4OTYtYjMzZi00YWIzMWNkNmM3OTAiCiAgIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDpkNzk0MDI4Yi00ZGZjLTQ1ZTEtODY3NS04N2RmNWI0MDhkYjEiCiAgIGRjOkZvcm1hdD0iaW1hZ2UvcG5nIgogICBHSU1QOkFQST0iMi4wIgogICBHSU1QOlBsYXRmb3JtPSJMaW51eCIKICAgR0lNUDpUaW1lU3RhbXA9IjE3MTIwNzA5NDc2NzAyMjEiCiAgIEdJTVA6VmVyc2lvbj0iMi4xMC4zNiIKICAgdGlmZjpPcmllbnRhdGlvbj0iMSIKICAgeG1wOkNyZWF0b3JUb29sPSJHSU1QIDIuMTAiCiAgIHhtcDpNZXRhZGF0YURhdGU9IjIwMjQ6MDQ6MDJUMTY6MTU6NDIrMDE6MDAiCiAgIHhtcDpNb2RpZnlEYXRlPSIyMDI0OjA0OjAyVDE2OjE1OjQyKzAxOjAwIj4KICAgPHhtcE1NOkhpc3Rvcnk+CiAgICA8cmRmOlNlcT4KICAgICA8cmRmOmxpCiAgICAgIHN0RXZ0OmFjdGlvbj0ic2F2ZWQiCiAgICAgIHN0RXZ0OmNoYW5nZWQ9Ii8iCiAgICAgIHN0RXZ0Omluc3RhbmNlSUQ9InhtcC5paWQ6NjI5MjdkOWUtOTI1OS00MmNkLTgzYTMtYjg5OTYxZmE2MjBhIgogICAgICBzdEV2dDpzb2Z0d2FyZUFnZW50PSJHaW1wIDIuMTAgKExpbnV4KSIKICAgICAgc3RFdnQ6d2hlbj0iMjAyNC0wNC0wMlQxNjoxNTo0NyswMTowMCIvPgogICAgPC9yZGY6U2VxPgogICA8L3htcE1NOkhpc3Rvcnk+CiAgPC9yZGY6RGVzY3JpcHRpb24+CiA8L3JkZjpSREY+CjwveDp4bXBtZXRhPgogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgCjw/eHBhY2tldCBlbmQ9InciPz5CU53FAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH6AQCDw8vTl87rwAACdxJREFUeNrt3V2MXGUdgPHnPTPbUkBpaQutgEUCggVUYGdRVCw7W4pRY9rtlhJiTDS2kJV+gJfYG9GoMdGopa0i0RgToZ+0u203FBMELwwJRFBMWjHBC3Fnqiaiod2dmdeLbm1pZ7a7tLN7zuzzS3rR3e3CnHOe+Z/3zFdgrFYfvILI1cB1wFzgQmD6Gf5VDsif4WfyIz83mjYg1PvGldPfnP5s11eT91zw3BEgolSovTnjgiO/nb/hou8efDnLt2P0g3f1oQuJ8V7g80SuB2am7QZUajnakqpHZMrEWhtDr7x74WBX4a5LD7zwl6zejqTuV7/454RVB7uJ8SVgM/CxNMahlEcSuSZE+kud7e9rnUBWH5xBvrYReAK42t2ss3QdIewtdxauzH4gqw6dT+QJ4L4xrAukMUcSA33lYseV2Q2k9085iD8BPputmxAard+VLtdH4r5ysWNBNgMZzt0HrHQ/6twtQupMEmJ/uauwIFuBfPnQFcAjDRftqd8LXt3N1CSJ7C13ZiOSY0GE+DUye5XKU6wMWhgD/eVi+iNJWHVwHrA023PcCZLNNQl95WLHe9M+QRYBc7KbhxMkw26IxP7S4vYr0hzIEveTJjMSamFP6c72y9MaSMF9pEn2IaphX2lx4fI0BnKt+0fpmCTsKS1O1yRJOPOzbaWJ8mFqYW+aIkncJ0qZG6mFPYOdhcsMRGowSUKgf7A4+ZEYiFK7cA/QP1jsuMxApIaRxKdKXYX5BiLVdwuR/smKJPOBHHuiiY+kt7ibiOweLLbPNxCpvvZA6BssFuYZiFTfzQF2l7smLhIDUZM07bS3ECN95WLHPAORGizcI3F3udg+z0CkRpOEsLtULFxqIFKDSICnysXCJQYi1XdrbGIkBqJW8JEIu0td5z4SA1HLTBIiO0udHXMN5CQRIPpIugC4jRD3lIrtcw1EajRJCLtKxcJcA5EaTRJ4qtR19pEYiFrVR4nsKnV2zDEQqfGaZEepWJhjIFJ9nwB2lro6ZhuIVN/HiXFHqdg+20Ck+m6HsGuwWLjYQKQGkyTAjvFEYiCaaj4ZYNdgsTB7SgQSAYKPpGt8C/cA28rF9llOEKm+RZGws3SG0y0D0ZQ+3QK2DnZ1zDQQqb7OEOO2wc76p1sGIkExhLBtsFiYaSBSo0kCW0unRGIg0gldwPbySZEYiHTKJInwZLmz/aLWCcRXFOrcWlwLYef2L912bf7SmRen5CB/Z591niQXcvjoLdsvOf/Z192v6XG48q4FB26b0R3qvMNiBIaSMOqn2w8no9/vVQNUk8Y/EIHqGe7+K0lo/AaQkTsOXpDsDu9/pBIzvi+GI/GmQw+3/dHDMj3yTy65sZrwYsz4Z2C2wgd41kII0UMyXSoJtZE78kxzkS4ZiGQgSpdgIFJDMRqI5ClWFu6s3JEyEMlAJAPRFBBa4uTXQCQDkQxEMpC6J7u+L5YMRDIQyUAkA5EMRDIQyUAktWggvmWDDEQyEMlAJAPRlOebNkhOEMlAJLVsID4MIgORDEQyEMlAJAORDER6B4KBuDvkBJEMRJKBSAaidIh+/IHkBJEMRJKBSAYiGYjSLxqI5ASRDESSgchFiIEoFXw9iOQplmQgkgxEMhClRDQQyQkiGUi2+ZY/MhDJQOQq3UAkA5EMRDKQbJzveiVLTZH/T3wu63G01cLR6U39T2xdcguBO/GS8plW5cMn/f0aYFrmA/kbazJ+E0IlxPxw03799iVFItuBi2zAU6ws3nHFyHC1SXF0EtlqHFP4FMtNMGocO4zDCaL6cWwzDjlB6sexHZjpxpATxDhkIOM6rTIOeYrlglxOkLHH4aVcOUHqxHGHk0NOkHq2LbnDS7lygjSKA3a4IJcT5PQ4FoGXcmUgo02OWe56eYp1+uTwtEpOEE+r5AQZXxw7jUNOECeHnCBODjlBnBxygjQpjtvxUq6cIHXj+IRxyEAax7ETmO1ulYGcbP6s24FdxiHXIPVuw4y2H+CLv+QEqSsYhwxEMhDJQCQDkQxEMhDJQCQZiGQg0jkNpOZmkOqKCfCq20Gq67UEeN7tINX1mwQ44HaQ6tqXEMOzwN/dFtLbDB6bIBtePsyxl6lKOmEHywdKI5d5w3eAf7tNJADehPBtOP44SIx/Bb4FRLeNprgIfHOkiZFANrwSieF7wK/dPpriDhBq36dnIJ4IBGDDy0cIyT3AC24jTVG/I3Av3U8fOf6Ftz/V5OHflwl8GtjnttIU00fkM3QPlE/+4unPxXr4lTKwFFgD/NPtphZ3GPgKxOX0DBw+9Zth1H/6jRvmUQurgB5gIWl9cuNVl8B039hE41qIvwr8CvgxywdKjX4wjOnXff2DMwhcTowF4APAVcCckT8zgOnANM7u7XcqQLXB94aof4WtRgh5rpq7gGn5tozvsH8AR07ZBiff7jjKdhhNArSNeV83lgdyZ/k7wshxcrbaxnBnXR3ZXkdGtu0g8BrwBwLPE3md5QNvjeV/ONue+VyOfx15Cbgxw3FsJuTW0r132Dv3dMn+60EOH83ybYjAFiLGYSDNugUhZjiOzUTW0DNgHAbSJLmQ1Ti2UEmMw0CarDaUxTg2UUvWsnJfxUPQQJocSJK1OB5lOKxhxb4hDz8DmYBbkGQrjlpYzz37qx56BjIx8klW4tjIcFjLiv2uOQxkIk+xjh4/ANM9OZLcg04OA5mEQNI+OcJGkvw6lvk4h4FMSiC5NMfxKEluPcv6vVplIJNkei6mMo7ARnKJcWR9iZv9CRLSFwdsJFbXsXTANYcTxEBOj6P2IMsPGIeBpEDlreMHZkriqKyj52kX5AaSEuelYpF+YnL0POPkcA1i46fE8SNidT09nlY5QVJ3ipWf/DiqPGQcBmIgp8fxQ2Lbg9ztU9YNJK2mDcVJiuNRKjxET5+PcxhIirUNT04csbaelQPG4SI95YZyxw/aiYpjE7Gy1qtVTpBsmLgXTEUImwisNw4DyY4YJigONpHLr6F7wFcCGkiGnP/fiYhjC0mynqV9Tg4DyZhqvtlxbKYSHmCZryE3kEwGkmtmHI8de/eR/V6tMpCMOtp2/GA+93FUQy8r9vkgoIFk2FvnNSOOnxLp5W7fYMFAMn8Lquc6jseI9PqOh2qNQL6wK9L4YxPGG8fjhFovPV7KVasEMnKidc7i6PbFTmq9QN446zgq+fvpfvqoh4RaMZBXzyKOn1PL9bKy38mhlg2k/x2sQyLwM2JYzYq9Tg61cCCBF4FfjjOOXxC4n579Lsg1yqHVKrYtmQP0AbeOIY4tJLV1LHPNoalxigXLBw4DdwGP0/iq1iDwAEMzeo1DU2uC/H+SLAowbSGETwE3A7M49jHAzwG7WT7whrtdY/U/dpW4anbr6sEAAAAASUVORK5CYII=",
  "$Meta": {
    "Type": "ActionTemplate"
  }
}

History

Page updated on Wednesday, April 3, 2024