How to properly format attachment data for Slack chat.postMessage












1















I am trying to incorporate a slack notification using a Slack bot app API into my C# application. The code below is working fine but the format used for the attachments field makes it very difficult to edit and maintain... There must be an easier way to populate that json array?



I've tried multiple ways to write it but I can't get it to work properly other than with this unwieldy syntax.



var data = new NameValueCollection
{
["token"] = "token", // Removed my actual token from here obviously
["channel"] = "channel", // Same with the channel
["as_user"] = "true",
["text"] = "test message 2",
["attachments"] = "[{"fallback":"dummy", "text":"this is an attachment", "color":"#F35A00", "title" : "Title", "title_link": "http://www.google.com"}]"
};

var client = new WebClient();
var response = client.UploadValues("https://slack.com/api/chat.postMessage", "POST", data);









share|improve this question





























    1















    I am trying to incorporate a slack notification using a Slack bot app API into my C# application. The code below is working fine but the format used for the attachments field makes it very difficult to edit and maintain... There must be an easier way to populate that json array?



    I've tried multiple ways to write it but I can't get it to work properly other than with this unwieldy syntax.



    var data = new NameValueCollection
    {
    ["token"] = "token", // Removed my actual token from here obviously
    ["channel"] = "channel", // Same with the channel
    ["as_user"] = "true",
    ["text"] = "test message 2",
    ["attachments"] = "[{"fallback":"dummy", "text":"this is an attachment", "color":"#F35A00", "title" : "Title", "title_link": "http://www.google.com"}]"
    };

    var client = new WebClient();
    var response = client.UploadValues("https://slack.com/api/chat.postMessage", "POST", data);









    share|improve this question



























      1












      1








      1








      I am trying to incorporate a slack notification using a Slack bot app API into my C# application. The code below is working fine but the format used for the attachments field makes it very difficult to edit and maintain... There must be an easier way to populate that json array?



      I've tried multiple ways to write it but I can't get it to work properly other than with this unwieldy syntax.



      var data = new NameValueCollection
      {
      ["token"] = "token", // Removed my actual token from here obviously
      ["channel"] = "channel", // Same with the channel
      ["as_user"] = "true",
      ["text"] = "test message 2",
      ["attachments"] = "[{"fallback":"dummy", "text":"this is an attachment", "color":"#F35A00", "title" : "Title", "title_link": "http://www.google.com"}]"
      };

      var client = new WebClient();
      var response = client.UploadValues("https://slack.com/api/chat.postMessage", "POST", data);









      share|improve this question
















      I am trying to incorporate a slack notification using a Slack bot app API into my C# application. The code below is working fine but the format used for the attachments field makes it very difficult to edit and maintain... There must be an easier way to populate that json array?



      I've tried multiple ways to write it but I can't get it to work properly other than with this unwieldy syntax.



      var data = new NameValueCollection
      {
      ["token"] = "token", // Removed my actual token from here obviously
      ["channel"] = "channel", // Same with the channel
      ["as_user"] = "true",
      ["text"] = "test message 2",
      ["attachments"] = "[{"fallback":"dummy", "text":"this is an attachment", "color":"#F35A00", "title" : "Title", "title_link": "http://www.google.com"}]"
      };

      var client = new WebClient();
      var response = client.UploadValues("https://slack.com/api/chat.postMessage", "POST", data);






      c# slack slack-api






      share|improve this question















      share|improve this question













      share|improve this question




      share|improve this question








      edited Nov 15 '18 at 21:56









      Gibolt

      5,87225344




      5,87225344










      asked Nov 15 '18 at 21:48









      MegasoumMegasoum

      82




      82
























          1 Answer
          1






          active

          oldest

          votes


















          0














          The "unwieldy" syntax is hand-crafted JSON and a much better approach would be to construct the attachments as C# objects and then convert them into JSON as the API requires.



          My example is using the external library Json.NET for the JSON conversion.



          Example for C# object:



          // a slack message attachment
          public class SlackAttachment
          {
          public string fallback { get; set; }
          public string text { get; set; }
          public string image_url { get; set; }
          public string color { get; set; }
          }


          Example for creating a new attachments array:



          var attachments = new SlackAttachment 
          {
          new SlackAttachment
          {
          fallback = "this did not work",
          text = "This is attachment 1",
          color = "good"
          },

          new SlackAttachment
          {
          fallback = "this did not work",
          text = "This is attachment 2",
          color = "danger"
          }
          };


          Finally, converting the attachments array to JSON for the API:



          var attachmentsJson = JsonConvert.SerializeObject(attachments);


          See also this answer for a complete example.






          share|improve this answer





















          • 1





            That did it! Thanks for the help

            – Megasoum
            Nov 15 '18 at 22:56











          Your Answer






          StackExchange.ifUsing("editor", function () {
          StackExchange.using("externalEditor", function () {
          StackExchange.using("snippets", function () {
          StackExchange.snippets.init();
          });
          });
          }, "code-snippets");

          StackExchange.ready(function() {
          var channelOptions = {
          tags: "".split(" "),
          id: "1"
          };
          initTagRenderer("".split(" "), "".split(" "), channelOptions);

          StackExchange.using("externalEditor", function() {
          // Have to fire editor after snippets, if snippets enabled
          if (StackExchange.settings.snippets.snippetsEnabled) {
          StackExchange.using("snippets", function() {
          createEditor();
          });
          }
          else {
          createEditor();
          }
          });

          function createEditor() {
          StackExchange.prepareEditor({
          heartbeatType: 'answer',
          autoActivateHeartbeat: false,
          convertImagesToLinks: true,
          noModals: true,
          showLowRepImageUploadWarning: true,
          reputationToPostImages: 10,
          bindNavPrevention: true,
          postfix: "",
          imageUploader: {
          brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
          contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
          allowUrls: true
          },
          onDemand: true,
          discardSelector: ".discard-answer"
          ,immediatelyShowMarkdownHelp:true
          });


          }
          });














          draft saved

          draft discarded


















          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53328361%2fhow-to-properly-format-attachment-data-for-slack-chat-postmessage%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown

























          1 Answer
          1






          active

          oldest

          votes








          1 Answer
          1






          active

          oldest

          votes









          active

          oldest

          votes






          active

          oldest

          votes









          0














          The "unwieldy" syntax is hand-crafted JSON and a much better approach would be to construct the attachments as C# objects and then convert them into JSON as the API requires.



          My example is using the external library Json.NET for the JSON conversion.



          Example for C# object:



          // a slack message attachment
          public class SlackAttachment
          {
          public string fallback { get; set; }
          public string text { get; set; }
          public string image_url { get; set; }
          public string color { get; set; }
          }


          Example for creating a new attachments array:



          var attachments = new SlackAttachment 
          {
          new SlackAttachment
          {
          fallback = "this did not work",
          text = "This is attachment 1",
          color = "good"
          },

          new SlackAttachment
          {
          fallback = "this did not work",
          text = "This is attachment 2",
          color = "danger"
          }
          };


          Finally, converting the attachments array to JSON for the API:



          var attachmentsJson = JsonConvert.SerializeObject(attachments);


          See also this answer for a complete example.






          share|improve this answer





















          • 1





            That did it! Thanks for the help

            – Megasoum
            Nov 15 '18 at 22:56
















          0














          The "unwieldy" syntax is hand-crafted JSON and a much better approach would be to construct the attachments as C# objects and then convert them into JSON as the API requires.



          My example is using the external library Json.NET for the JSON conversion.



          Example for C# object:



          // a slack message attachment
          public class SlackAttachment
          {
          public string fallback { get; set; }
          public string text { get; set; }
          public string image_url { get; set; }
          public string color { get; set; }
          }


          Example for creating a new attachments array:



          var attachments = new SlackAttachment 
          {
          new SlackAttachment
          {
          fallback = "this did not work",
          text = "This is attachment 1",
          color = "good"
          },

          new SlackAttachment
          {
          fallback = "this did not work",
          text = "This is attachment 2",
          color = "danger"
          }
          };


          Finally, converting the attachments array to JSON for the API:



          var attachmentsJson = JsonConvert.SerializeObject(attachments);


          See also this answer for a complete example.






          share|improve this answer





















          • 1





            That did it! Thanks for the help

            – Megasoum
            Nov 15 '18 at 22:56














          0












          0








          0







          The "unwieldy" syntax is hand-crafted JSON and a much better approach would be to construct the attachments as C# objects and then convert them into JSON as the API requires.



          My example is using the external library Json.NET for the JSON conversion.



          Example for C# object:



          // a slack message attachment
          public class SlackAttachment
          {
          public string fallback { get; set; }
          public string text { get; set; }
          public string image_url { get; set; }
          public string color { get; set; }
          }


          Example for creating a new attachments array:



          var attachments = new SlackAttachment 
          {
          new SlackAttachment
          {
          fallback = "this did not work",
          text = "This is attachment 1",
          color = "good"
          },

          new SlackAttachment
          {
          fallback = "this did not work",
          text = "This is attachment 2",
          color = "danger"
          }
          };


          Finally, converting the attachments array to JSON for the API:



          var attachmentsJson = JsonConvert.SerializeObject(attachments);


          See also this answer for a complete example.






          share|improve this answer















          The "unwieldy" syntax is hand-crafted JSON and a much better approach would be to construct the attachments as C# objects and then convert them into JSON as the API requires.



          My example is using the external library Json.NET for the JSON conversion.



          Example for C# object:



          // a slack message attachment
          public class SlackAttachment
          {
          public string fallback { get; set; }
          public string text { get; set; }
          public string image_url { get; set; }
          public string color { get; set; }
          }


          Example for creating a new attachments array:



          var attachments = new SlackAttachment 
          {
          new SlackAttachment
          {
          fallback = "this did not work",
          text = "This is attachment 1",
          color = "good"
          },

          new SlackAttachment
          {
          fallback = "this did not work",
          text = "This is attachment 2",
          color = "danger"
          }
          };


          Finally, converting the attachments array to JSON for the API:



          var attachmentsJson = JsonConvert.SerializeObject(attachments);


          See also this answer for a complete example.







          share|improve this answer














          share|improve this answer



          share|improve this answer








          edited Nov 15 '18 at 22:32

























          answered Nov 15 '18 at 22:25









          Erik KalkokenErik Kalkoken

          13.3k32552




          13.3k32552








          • 1





            That did it! Thanks for the help

            – Megasoum
            Nov 15 '18 at 22:56














          • 1





            That did it! Thanks for the help

            – Megasoum
            Nov 15 '18 at 22:56








          1




          1





          That did it! Thanks for the help

          – Megasoum
          Nov 15 '18 at 22:56





          That did it! Thanks for the help

          – Megasoum
          Nov 15 '18 at 22:56




















          draft saved

          draft discarded




















































          Thanks for contributing an answer to Stack Overflow!


          • Please be sure to answer the question. Provide details and share your research!

          But avoid



          • Asking for help, clarification, or responding to other answers.

          • Making statements based on opinion; back them up with references or personal experience.


          To learn more, see our tips on writing great answers.




          draft saved


          draft discarded














          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53328361%2fhow-to-properly-format-attachment-data-for-slack-chat-postmessage%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown





















































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown

































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown







          Popular posts from this blog

          Florida Star v. B. J. F.

          Danny Elfman

          Lugert, Oklahoma