HipChat - Notify

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

{
  "Id": "6a6ce997-c91b-4e06-b237-4484417efc89",
  "Name": "HipChat - Notify",
  "Description": "Notifies a HipChat room of a deployment outcome.",
  "Version": 0,
  "ExportedAt": "2014-07-29T01:56:04.693+00:00",
  "ActionType": "Octopus.Script",
  "Author": "stephengodbold",
  "Parameters": [
    {
      "Name": "AuthToken",
      "Label": "API Auth Token",
      "HelpText": "HipChat authentication token for a user who can post notifications to rooms",
      "DefaultValue": null,
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Name": "RoomId",
      "Label": "Room",
      "HelpText": "The room name that you wish to post a notification to",
      "DefaultValue": null,
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Name": "NotificationText",
      "Label": "Notification Text",
      "HelpText": "An optional text override for the notification. Default is: <(succeeded) or (failed)> (Project) v(Release) deployed to (Environment) on (Machine)",
      "DefaultValue": null,
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Name": "NotificationColor",
      "Label": "Notification Color",
      "HelpText": "The color for the notification for the room. Default messages will receive green success, and red failure.",
      "DefaultValue": null,
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    }
  ],
  "Properties": {
    "Octopus.Action.Script.ScriptBody": "#--------- Notify-Hipchat\n$apitoken = $OctopusParameters['AuthToken']\n$roomid = $OctopusParameters['RoomId']\n$messageText = \"(successful)\"\n$color = 'green'\n\nif ($OctopusParameters['Octopus.Deployment.Error']) {\n    $messageText = \"(failed)\"\n    $color = 'red'\n}\n\n$messageValue = \"$messageText $($OctopusParameters['Octopus.Project.Name']) [v$($OctopusParameters['Octopus.Release.Number'])] deployed to $($OctopusParameters['Octopus.Environment.Name'])    on $($OctopusParameters['Octopus.Machine.Name'])\"\n\nif ($OctopusParameters['NotificationText']) {\n    $messageValue = $OctopusParameters['NotificationText']\n    $color = $OctopusParameters['NotificationColor']\n}\n\n$message = New-Object PSObject \n$message | Add-Member -MemberType NoteProperty -Name color -Value $color\n$message | Add-Member -MemberType NoteProperty -Name message -Value $messageValue\n$message | Add-Member -MemberType NoteProperty -Name notify -Value $false\n$message | Add-Member -MemberType NoteProperty -Name message_format -Value text\n\n#Do the HTTP POST to HipChat\n$uri = \"https://api.hipchat.com/v2/room/$roomid/notification?auth_token=$apitoken\"\n$postBody = ConvertTo-Json -InputObject $message\n$postStr = [System.Text.Encoding]::UTF8.GetBytes($postBody)\n\n$webRequest = [System.Net.WebRequest]::Create($uri)\n$webRequest.ContentType = \"application/json\"\n$webrequest.ContentLength = $postStr.Length\n$webRequest.Method = \"POST\"\n\n$requestStream = $webRequest.GetRequestStream()\n$requestStream.Write($postStr, 0,$postStr.length)\n$requestStream.Close()\n\n[System.Net.WebResponse] $resp = $webRequest.GetResponse()\n$rs = $resp.GetResponseStream()\n\n[System.IO.StreamReader] $sr = New-Object System.IO.StreamReader -argumentList $rs\n$sr.ReadToEnd()",
    "Octopus.Action.Script.Syntax": "PowerShell"
  },
  "Category": "HipChat",
  "HistoryUrl": "https://github.com/OctopusDeploy/Library/commits/master/step-templates//opt/buildagent/work/75443764cd38076d/step-templates/hipchat-notify.json",
  "Website": "/step-templates/6a6ce997-c91b-4e06-b237-4484417efc89",
  "Logo": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAMAAACahl6sAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAAxQTFRF////HVCAvMvZaourDJE3ngAABCpJREFUeNrsXe12KyEI3DDv/85N2rT52igrg2DK3D/tPafqCCIqsNtWKBQKhUKhUCgUCoVCoVAoFAoFZ4gILjj94fvX838vxOF++Hs488kvhw6HOzZ5ZaMncSPzCSwychllkYyLicWVy+rCSCMWFo1gKkwagVTYNKKoONCIWPZycsNUoZw8MU+/dFr14+v+elTfPwJIpF/9RY6mQyiioBO/OpQuepeMhKrVIde84/IjbJWPrNEWF8Qsj2FTgwD1Ep8uZfaSFze7/1bSMpOHpG9c1ZWs0n67H6plwQwmMsMp2l8q4s9j0nbLZBJrUVx5uO27cFRhTPUf/HqTyb6pzNurnH1spx4jTj0efSLidkD4y0QiTqF7MpFsDQZNIMJunYTbc+DtmTBFgsgLTWLnEnsxC5o6IE6xqPMosTx4A0D4Qx9pBNECeRXJqgIhjSHENXEYhKR4CoddvZFBIM8igbmFsEdw83xKDoHYJxRZgkWsA0miWWbVSKNZ1ilFFoE8zyn+K5E8mmUcS6YANxiISB7Nsg0GiTTLpB6fSSQ8BhRFJJXRMil6JqP1bLaKSBEpIkWkiBSRGCIr7+zlNKYmUgerBEQ+5sz+MbcoqrskgMnwkiYj/HstxSx4BDDztaOvl/CINwR9vfZv48GMAUVjvo0PHN0/B8+oSUtxrA8c3Yci8QgKk4GB0HSLGILkoFmKBoSx1zwG9m98zdK8C9tDCqT/nmR/Z5eT1gKPdqOJxxLCo6wiDATj8fivySIYHMTRCdP0o+WylxgKhcwHDb1mNnA4z/VdRujmJRBlsBRaydOvHHAoD5QVMqYKoUMvGfyKgcRvTgDdpo0yJVQbENVEGnZdXUsyh4fFEdJuFLaSO8bOR0Ty1v6N1xZ5a+CosfEHcgZA1Sp6tsKRvAvhadVOY9aT6KGEFJCksdet+fR2LMfqSOm2I2uTcTWAY0lCotKwdpUL8eCx5xh2xNyrryH0HkeXiaLdfbcKmoIjfhmcGG75Umbn+k9dalIcM4NnZh379uWZm909qTFfNSSyQob/TLHVa0LNh8AqHHO0lzlfU6qJNHxC1qKXidWDXGvGYZI8mh4hg8o8C9/2bR28bNdXcbhVJZRpvoPiGGjiMjsPlVMVsEtkRowCpU7jK9+AqBHVGfBaOPPRpb+/OZWmSLY5oJSWRavRWeEvlOqyT+olMeEvFCoSrlsbqQLzg1CCREJaKogXCYuKJBAJh8pNv0IMF3PZ/1GJjkAEi0qocpFs2A+VFAHHsJI5ezUpKmZsilrXtJegGWQ6bC7eJJZgcnd//Yh7bxhjbkxGYBmhsCxd/q9Fqaks8BUvJZUVvkemej1d5MNqiu9ObKugs5Eu9Km79qP2SkRaHg62BbFDZkkeN3/tlxBkKxQKhUKhUCgUCoVCoVAoFAqFwhF8CTAA/z8hbAhfKXMAAAAASUVORK5CYII=",
  "$Meta": {
    "Type": "ActionTemplate"
  }
}

History