Embedding Survey in an Email

role administrator minimum version 2024 2 and above the ism application sends a survey via email to customers whose incident , service request , etc , have been resolved and closed the intended user / customer should be able to submit their survey response directly from the email, rather than having to navigate to a survey link within the email the following steps will allow you to configure how to embed a survey within an email pre requisites this is the step where you configure your microsoft account with the connector using actionable email developer dashboard configure the provider/connector using the actionable email developer dashboard by signing in to your outlook account navigate to the link https //outlook office com/connectors/oam/publish embedding a survey in an email is supported only in outlook accounts refer to the microsoft documentation https //learn microsoft com/en us/outlook/actionable messages/email dev dashboard for more details new provider click on new provider link and provide the following details friendly name provide a user friendly connector name provider id this field is auto populated remember to keep the provider id handy while configuring the ism application organization info this field is auto populated sender email address email address from which the email with the embedded survey is sent target urls this endpoint submits the survey response it refers to the api url where you send the survey data follow the steps below to learn how to obtain the target url a go to https // /data/designer workspaces xml b in the xml document, search for survey workspace id="survey#" searchable="false" name="survey" link="{target url}/account/login?sessionkey= " recentlist="false" visible="false" default="false" visibleinmainmenu="false" closable="true" adminrolerequired="true"/> this is how the entry appears in the xml text c copy the survey tenant url value d append /api/takesurvey/saveemailresponse example https //{survey tenant url}/api/takesurvey/saveemailresponse new provider scope of submission this is where you provide the scope submission of provider or connector test user this is for testing purpose to test your providers on users from same tenant organization this will send embedded survey notification to users within an organization which needs to be approved by exchange administrator of the organization e g \<email address>@organization com global this will send an embedded survey notification to users worldwide contact info this is where you provide the contact information of provider or connector provide the name, email address, phone number, address, city, state, postal code, etc of the sender publisher information this is where you provide the details of the publisher such as their display name, website, etc scenario this is where you provide the details of the scenario such as the action you plan to add to your email, the daily number of emails you expect to send, etc information to verify your actionable messages provide the information about actionable message detailed instruction to test your actionable message provide an actionable message card payloads how the html message should render in the email body you can add one or more payloads these are surveys in json template here is the card payload sample sample card payload json { "type" "adaptivecard", "version" "1 0", "$schema" "http //adaptivecards io/schemas/adaptive card json", "padding" "none", "hideoriginalbody" true, "body" \[ { "type" "columnset", "columns" \[ { "type" "column", "items" \[ { "type" "textblock", "text" "test survey", "wrap" true, "size" "extralarge", "weight" "bolder", "horizontalalignment" "left" } ], "style" "emphasis", "spacing" "none", "padding" { "top" "default", "bottom" "default", "left" "default", "right" "none" }, "width" 80 }, { "type" "column", "items" \[ { "type" "image", "alttext" "survey logo image", "horizontalalignment" "right", "url" "data\ image/jpeg;base64,/9j/4aaqskzjrgabaqaaaqabaad/2wceaaohcbuvehgwehuygbgagriyhrwygbgygboygrwzgrgzghwcis4lhcerixkyjzgmky8xntu1giq7qds0py40ntebdawmea8qhxishjcrjcw0pzq0njqxndq0odq0ndq0ndq0ndq1ndq0ndq9njy0ndq0ndq0ndq0ndq0ndq0ndq0np/aabeialcbewmbigaceqedeqh/xaacaaeaaqubaqaaaaaaaaaaaaaabwedbaugagj/xabceaacaqibcaygcaueaweaaaabagadeqqfbhihmufryqcicygrormyumkissnccokssshcfenj0eeznnlxo7pwjp/eabkbaqadaqeaaaaaaaaaaaaaaaabagqdbf/eacuraqacagedbqadaqaaaaaaaaabagmrmrihqqqimlfxexsbyf/aaawdaqaceqmrad8amaiiaiigiiiciiaiigiiiciiaiigiiiciiaiigiiiciiaiigiiiciiaiigiiiciiaiigiiiciiaiigiiiciiaiigiiiciiaiigiiiciiaiigiiiciiaiigiiiciiaiigcjlnpqhh67uwsozjo6rqlyegnbrml6ipgbziuvqekorvpx0tcemlmrduvyczfgenellappc4zqj17wyid53nd5g6k06ikaagdwhvlb9sz1yzotplotiikduotll2lzhnsdltkvcnsaxqdtqehxoxsq9jeg/jbbdot7dmbca1m06hucfn5gqbfq7vcnr9gukt+tehw7izjuukxcmbanycyq/oxphijerm057nuykp+yxlehif0qfrxa2gxdd7snwo8tyt57wouklgotsi5v12hcrvddedvemznnlayvdruuwpquu3rcbr2bcore7ysvv2nlwyy+nvhdcs1xrkilnyko1ksqoa5k7jj5ux6ukl1apsqi54ncaojjsb2yfm4m4k2mqavq2qe6ka9rbu+03fj5dvlzmkv/uuxzzkoiz6wkm3pti+4lrh4hbhumtl0gyin1276bj9jdktpoezrhp6p5yfndhq5apvljowg6sexwaj7ptp85k5h/3y4tts08+xpmtlfsxpgwdnwycni/wxnthzs6uz7nuud8go3cwinhgbfwbg6wrwnuagdsj4qofbleaaekk2aa2kndoey90iihkyvruyatnrimdya1t5dmzs14rytws24d9f5b2mzuxtu667kofoyad66/emax8o1m9atvpbuc/rou+ojxdrgcfmvos8t56tg1rsqopvt/ez+ezmxlp1cq/yzay8hupkr/y+4t/xnxkdpwrhknpgqagyimgx2k1oozumzd2jo/yvlajiaenqcmn+5lpbgdypbotclbcovsdq8theroiherareqereberareqij6tqejj0f2qvm96u4/qtouj6r9jwxitm/hlj9wmr6wqx0mhfitvfaor+yyvr3x/ap1ee1rbxdif7zhpbm1c4umsds+mqxyhxj2kwudiqq/o8ngqxlvl5tcnsokipyan9p09r8vmhybfn3m81aiiucbbsbjbv1rzurr7z1wwswmnupn+hx0nqdqkfihi2bljpinfbsm+ytuvmcruc+zb+02srgxxnnz5tmyw6+3bt52r0wpuyocgvipb2hgbgdr0dzunhfhcepwgieacxkh5r96zhsjk8jikqqlcqh0vtjzse9wqfdnjysoymrrtr1ydqkmplom+y/47r76frt+lpkhaptwynqqbufmzxca9gbp3hoac31cbborf+lxtdwbgtyfzqbb5lnjmzkb0ibztztfequfv3tf8mjjbdplokuohj5ezsxgj1qfrqbfnva/aaa2pz4zpyj0fyumpzclydcpkv3k2o9gn5lgdwq00cilbqajkttxbht35z7z7dxbh85ohulwbbbiiiiii2gg7dpiktz+zrdej6agv06dwb/mububdce7hanmdkyq9ql6koqggkajkga6xa2o7pnvsazpopki0jg6msqu9f6fs59fofsfybs6v3spbgn07kzm80clgiru66lpbq7wourfgssdxite6rssgjhfrobpwuvmib9ir3ed70047tgojsy3ijytfxi58z1heoanfrufnir/myfwpfbug/bwtx8oj7rcxsbczle02nctdaxwnq8xozydmbvrapwb0shwabdyonjqxv8j0b6mspb/xr37af/cwjfay3ekzlpe6lfksrmb0zsatqxaj3lus3xkf2zjcr5exgfa1dcooomosjdjdvfkbhlits1eytxjw3etfmnj2uatcoklfirdwyey4+spmjpuhae/kbs1c4aempasjrdbb0v6p3ecvoux7t030gpigvnwuisslzbu6+2h9ze3eoyenbdv1qirobqwvgrvbfwzsxx6o78sewntpbhfiinvyiiiciiaiigiiihadlfk+hotwqlfxix/yjzmyne2ooj2ldfgy/tnz9jthsyezew9jvftd98jpn7hlrxvcoxsqmc1hchtchunz1gy8vbjetwpvjme9sd87e9hlosefvh8qj/rjawocofrf6ddcebbrb8lwmjvprwejikqd1almc/vibhyzj0zattckyn1v3djmljxuqvlvrttpgwb+ynbsfsx8qcjjklgy1aate7awtoh8qud8mksftz7nfsm8e/bgelilfd0w4vdh8smf2ir7kulpay4aj+ykjdk7j+fplvnyhucvl/mtic06gnuqckx8w/zm/qpllr6f4w0dudzu1vnjgzoqdswye7pd5r3+znazqplkzqdzv4xupkdnmzjwmzhlj1a1/wdg6jztodflh6vb4z+sl+jizsxyo0alvhcijurx0qtbyknyvplg1csaxue+rtsghiedy95m33yrvipjm/cclxiqw+ewntzwj+0ff8wj85tcp0j4pfxwkw5qynxdw8pzjpxzc04leetshokjgmpj2w+qklnlbtjhpsfjufdm8odjwt9jhjq3pudetkpnojzir6emxdcattwdfr5asuxjw1dvlfdjtw25hrziozwqvar1lukeizx2fz6o7by/h5zimmqdvs+whs/ac9vhku5huryuudru5vywyfnt4zjjrfrxe/rtlt00my/hussrpqycy+lwqvuzkqhkywkslgizeqipzuzfodr6iuab3zgo229dzw47qrzmgkydieafxao1utstub5lqf4s3gjdcw5a9nuzdit1v7qgyvujlkonhnosddjtx2huv8w47lskj2vrhicumznz0m/erkr5axjgk2rqzq7rkwoijuysiiaiigiiiciibo878e1ba1qdmfmkgqba5zwdac/zirxwfem2jvr0pb1zd3aq1z6he9jbby+m0ltefho1fvlo0moyee4zccwnbriytwnipvin83ghyriqthsvxamazql3w6hr6i46inw3vyne4znxa1v5tuw40mspwm6+u3wq8i0acqqvhfqbchmfhfadfqbfwdo3zjgg23ec9dipwx27jjwbefibammjubyvb1tidzpknd+ybvymsz3zpekzv8mpakxloqi5pk7sbvtfy7jw8pu+oy3syvdvn3nculqotek0qyaxii02a12sddhyax5y5mmlhvc7ztrezgkspiwckbwkkzh5hyhxywpqsw99zw4gatfic5w3vktrzk8doou/eocz/wan+hxmzu6unhc4xqyekx+8jochiwpujr6yojdtuhh8pkvsrkg1skkqc70sw5ldbthdyn90yi7y+svtztfbrqnpimmwh0d1k1jgdwdqrr5i+zlioyjgklbylzcjkba9h5qdja8ropzfzo/hianyk0gn1bb6njt1eyd43hxvmlnwp1ubgi6snr1mphym7arlio/dw3bfmxrs+eyksz65nwfddpuahtdscqbbowc7puiubtpisj5wvxpntvs/vg2vhqwkh7qpixluwxfuf1kv52m1zfwhdvw3r1qnkn/pymlntq0mdxx+q7dznthkwli8rzpegjggs9/dfzuj9zmuy/8asknv6n/seqprax7j8jje6nsuhwaxfteoh7zpjyedshz/amcvufh/af10re2szerawmt0w2frkdjuqq+kkt5/bk+zw1tdb4hvzo1j8lwkb2mx1hmnxp+jj1xr3/v6xzwhwmzys7lo1o3xih2uqt8k/dofpnh67x+e/ixyij6lzyiiaiigiiiciibsa18oee2u8lrimnpiwnfd8rpeewx0gwnrh/ubyqj50qojakattar4pv1hwea1zl8ozewvziz4yak3lixqk7ydgwj7zu6lenwd8spqkwjfky7cmxjobeaq3p0flf1lue7tjhhokatsmg9habbbygslnthmirer4rbc+wswbfjrbkl555tthk2kopohjknch2mmezdxhyznuxsdg0ru2p1vdqwsqdn/ahiyui0jx3mk7fpaorsmy8llats/0nzoogzlftanjopy/wbh1ams2f+ltboegvf5a9tjnqpi7zx2jwz0zaqjoedqupxcy5pnz7w21vw0pwmxtss2lwdna1rsxaw4c+wdksgx2tiwwt61zgtgm7k+ypi722dvm73n3o+ymhxbab9btc/ebyo6/aiitrcqib0r5zoywst1xydwmcafaqnfsi4hbkx7obmj6umn6glwqb1aqc599oqfh0jk1ciqkfqaaaaaagbnfntku4rcmqc9rounesabr3i47btr/frhryz/amu79xhcgm6/o8y2tdemm5slbrue7buhqenyvbozj5ww3zpw3to4abv6o0+joka5rz8ffwljllrylvhwnudjaftdxxg+sdg8btqrpunvxxug+ntk2vyvtxlfalq8wyollzxuqbqsxaabjjnganpj3too5bpixwp4blvrqmqdsvpn8kkd8h0zpm984bi8rzd9ftuq+8t6z99gbyhoc1mow3vbs3yq9ne5jm6mmhy1khgxkadta7upysn6fptylsudz4dax7hc90nhnxagjhvdcznd2hatshcned0ya7vh/ez7arr7buiibmiiigiiiciiaiigiiicumrec2aylsgisrpcqmcrhrhvslumhugibei8tmnk6ttdbmjimwf1klnyevucbytcejjkhi1mzuo+3zqlfxrdab8iazdajylpqmpo1omgfhsaraine+r7jmznik2wcxj9vu4/pjrkjj6bculyl1uv9ioaxrmxnbboxvuud1go1wpzo/gdew6uetpowqclgr5nn0f6rntbwum5nimy39xvq/zormnkzzcu81amexxknkqebdaznhhoh0lnjxulw8rlelwr0nk1vzhh1xbu9uvaoy1szms1+2mlfteu86swostap3uw/mdmlh5yr1tvwq7d2wzivgtayesdmoiidxmlme+kyvkokunt9jpytl73hfdmvm06hfrxwnyyuj/n41n9nux6nslx+srrt2xavyfvrswpzw2hsmgsmovvaaa1aas9nuokvhiyxm07viinrqiigiiiciiaiigiiiciiaiigiiifcj5kce4gualuprb7emuxa1tshbblxo5tgw8sttldlbe6d3gvbvl6wkk2mrxqai1bzkqtwsqjrg0wnymny+jliohjudstnslzmvoidg1kdzdcvrr14ny2pexgo8xocxwzwcfxtaprpanpl8vz5ib9qc8ftktxfk8trhyr9gbhxtxsec6z+ycz1r6mhv18sohu0yt4lp1vkoym6mxmywupb1pqphd/irgonmezkv9tjkjmtcusgztvyb6liaesgbfegdubkxosviohkzmevyijzberareqereberareqereberareqereberareqepavibs0sul5fibhttnn+gjmbavkattrkmepc/zldu5uz5zadokatto2pzxotz1snbzsmo1ormj29ylfw6rbnx4f4m0mmkty4spcwo0fkteqzdjiilkereberareqereberareqereberareqereberareqereberareqkthqu5kyhedbank0ryzkzj40jxsdr8skrliiiiciiaiigiiiciiaiigiiiciiaiigiiiciiaiigiiiciiaiigiiiciiaiigiiiciiaiigf/z", "size" "small" } ], "style" "emphasis", "width" 20, "spacing" "none", "padding" { "top" "small", "bottom" "small", "left" "none", "right" "default" } } ], "padding" "none" }, { "type" "container", "items" \[ { "type" "textblock", "text" "the survey will take just a minute ", "wrap" true, "size" "medium" } ], "separator" true, "spacing" "none", "padding" "default" }, { "type" "container", "items" \[ { "type" "textblock", "text" "1\\\\ how satisfied were you with the overall resolution process for your recent it service request? ", "wrap" true, "weight" "bolder" } ], "separator" true, "spacing" "none", "padding" "default" }, { "type" "container", "items" \[ { "type" "input choiceset", "choices" \[ { "title" "very satisfied", "value" "verysatisfied" }, { "title" "satisfied", "value" "satisfied" }, { "title" "neutral", "value" "neutral" }, { "title" "dissatisfied", "value" "dissatisfied" }, { "title" "very dissatisfied", "value" "verydissatisfied" } ], "style" "expanded", "label" "how satisfied were you with the overall resolution process for your recent it service request?", "id" "rbtn1", "isrequired" true, "errormessage" "this field is required " } ], "padding" { "top" "none", "bottom" "default", "left" "default", "right" "default" }, "spacing" "none" }, { "type" "container", "items" \[ { "type" "textblock", "text" "2\\\\ did the it support team meet your expectations in terms of response time?", "wrap" true, "weight" "bolder" } ], "separator" true, "spacing" "none", "padding" "default" }, { "type" "container", "items" \[ { "type" "input choiceset", "choices" \[ { "title" "exceeded expectations", "value" "exceededexpectations" }, { "title" "met expectations", "value" "metexpectations" }, { "title" "somewhat below expectations", "value" "somewhatbelowexpectations" }, { "title" "well below expectations", "value" "wellbelowexpectations" } ], "style" "expanded", "label" "did the it support team meet your expectations in terms of response time?", "id" "rbtn2" } ], "padding" { "top" "none", "bottom" "default", "left" "default", "right" "default" }, "spacing" "none" }, { "type" "container", "items" \[ { "type" "textblock", "text" "3\\\\ please select all the aspects of the it service that you were satisfied with ", "wrap" true, "weight" "bolder" } ], "separator" true, "spacing" "none", "padding" "default" }, { "type" "container", "items" \[ { "type" "input choiceset", "choices" \[ { "title" "timeliness of response", "value" "timelinessofresponse" }, { "title" "clarity of communication", "value" "clarityofcommunication" }, { "title" "effectiveness of solution", "value" "effectivenessofsolution" }, { "title" "overall customer service", "value" "overallcustomerservice" } ], "style" "expanded", "ismultiselect" true, "label" "please select all the aspects of the it service that you were satisfied with ", "id" "chkbxb1", "isrequired" true, "errormessage" "this field is required " } ], "padding" { "top" "none", "bottom" "default", "left" "default", "right" "default" }, "spacing" "none" }, { "type" "container", "items" \[ { "type" "textblock", "text" "4\\\\ please provide details", "wrap" true, "weight" "bolder" } ], "separator" true, "spacing" "none", "padding" "default" }, { "type" "container", "items" \[ { "type" "input text", "label" "please provide details", "id" "txtbx1" } ], "padding" { "top" "none", "bottom" "default", "left" "default", "right" "default" }, "spacing" "none" }, { "type" "container", "items" \[ { "type" "actionset", "actions" \[ { "type" "action http", "headers" \[ { "name" "authorization", "value" " " }, { "name" "content type", "value" "application/json" } ], "id" "btnsubmitsurvey", "title" "submit survey", "method" "post", "isprimary" true, "style" "positive", "url" "https //\<survey url>/api/takesurvey/saveemailresponse", "body" "{\\"tenantid\\" \\"\<tenant url>\\",\\"surveyid\\" \\"\<survey id>\\",\\"ot\\" \\"\<object type>\\",\\"oid\\" \\"\<object rec id>\\",\\"responses\\" \[{\\"id\\" \\"rbtn1\\",\\"value\\" \\"{{rbtn1 value}}\\"},{\\"id\\" \\"rbtn2\\",\\"value\\" \\"{{rbtn2 value}}\\"},{\\"id\\" \\"chkbx1\\",\\"value\\" \\"{{chkbx1 value}}\\"},{\\"id\\" \\"txtbx1\\",\\"value\\" \\"{{txtbx1 value}}\\"}]}" } ], "horizontalalignment" "left" } ], "padding" { "top" "small", "bottom" "small", "left" "default", "right" "default" }, "separator" true, "spacing" "none" } ] } configure a provider in ism application from modern survey login to ism application using administrator go to configuration console select surveys under communication templates from left navigation pane remember to use modern survey configure embed survey click configure embed survey and enter the provider or connector id created in step 1, then click save click add a new survey to create a new survey or select an existing one send the survey using a trigger or workflow action, then drill down into the selected survey, click publish , and choose either web link or embed as email specify the relevant business object , provide the appropriate action a message will appear confirming that the template has been copied to the clipboard you can configure the copied template in the workflow email or trigger action email to ensure the survey is sent to users limitations of embedding survey in an email the following types of survey are not supported to embed in an email surveys with questions featuring dynamic condition sets surveys consisting of multiple smiley rating questions surveys consisting of multiple star rating questions