{"id":5901,"date":"2015-09-06T20:51:06","date_gmt":"2015-09-06T20:51:06","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/webdev\/2015\/09\/06\/integrating-with-salesforce-using-asp-net-webhooks-preview\/"},"modified":"2023-09-19T11:22:45","modified_gmt":"2023-09-19T18:22:45","slug":"integrating-with-salesforce-using-asp-net-webhooks-preview","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/dotnet\/integrating-with-salesforce-using-asp-net-webhooks-preview\/","title":{"rendered":"Integrating with Salesforce using ASP.NET WebHooks Preview"},"content":{"rendered":"

In the blog Introducing Microsoft ASP.NET WebHooks Preview<\/a>, we gave an overview of how to work with Microsoft ASP.NET WebHooks. Out of the box we provide support for a variety of existing WebHooks providers such as Dropbox<\/a>, GitHub<\/a>, MailChimp<\/a>, PayPal<\/a>, Slack<\/a>, Trello<\/a>, and many more.<\/p>\n

Salesforce<\/a> does not support classic WebHooks, but they do have a concept called Outbound Soap Messages<\/a> which shares many of the same characteristics. As a result, it is possible to receive these messages using ASP.NET WebHooks which we will describe here. To support receiving Outbound Soap Messages you need to install the Microsoft.AspNet.WebHooks.Receivers.Salesforce<\/a><\/b> Nuget package into your Web Application but more about that later.<\/p>\n

Configuring Outbound Soap Messages<\/h3>\n

In order to setup Outbound Soap Messages<\/a> you need a Salesforce developer account. Then login to Salesforce.com<\/a> and select Setup<\/strong> at the top of the page:<\/p>\n

\"SalesforceHome\"<\/a><\/p>\n

Then you select Build<\/strong> | Create<\/strong> | Workflow and Approvals<\/strong> | Outbound Messages<\/strong>.<\/p>\n

\"SalesforceCreate\"<\/a><\/p>\n

Here you may see an Understanding Workflow<\/strong> page, which you can read if desired, and then continue to the Outbound Message<\/strong> page where you select New Outbound Message<\/strong>:<\/p>\n

\"SalesforceOutbound\"<\/a><\/p>\n

Here you pick an object such as Lead<\/strong> and then you fill in the required information. Just like described in the blog Introducing Microsoft ASP.NET WebHooks Preview<\/a> the URI must be public and have the form https:\/\/<host>\/api\/webhooks\/incoming\/sfsoap<\/b>. If you check Send Session ID<\/strong>, then the outbound message will contain a session ID which can be used for subsequent calls back to Salesforce. Lastly you pick the message fields you want in the notification.<\/p>\n

\"SalesforceEditOutbound\"<\/a><\/p>\n

Now we have defined a message \u2013 next we have to define a workflow rule which uses the message. Select Build<\/strong> | Create<\/strong> | Workflow and Approvals<\/strong> | Workflow Rules<\/strong>. Here you may again see the Understanding Workflow<\/strong> page, and after that you select New Rule<\/strong>:<\/p>\n

\"SalesforceCreateRule\"<\/a><\/p>\n

Fill in the required fields, for example like below, and save:<\/p>\n

\"SalesforceEditRule\"<\/a><\/p>\n

Finally, it\u2019s important to check that the rule is marked as Active<\/strong>: <\/p>\n

\"SalesforceRuleActive\"<\/a><\/p>\n

Configuring Receiver<\/h3>\n

The next step is to configure the WebHook receiver. First make sure you install the Microsoft.AspNet.WebHooks.Receivers.Salesforce<\/a><\/b> Nuget package into your ASP.NET application. Then the registration happens exactly like in the blog Introducing Microsoft ASP.NET WebHooks Preview<\/a> by adding line 21 to the WebApiConfig.Register<\/strong> method:<\/p>\n

\n
\n
   1:<\/span> using<\/span> System.Web.Http;<\/pre>\n
<\/p>\n
   2:<\/span>  <\/pre>\n
<\/p>\n
   3:<\/span> namespace<\/span> WebHookReceivers<\/pre>\n
<\/p>\n
   4:<\/span> {<\/pre>\n
<\/p>\n
   5:<\/span>     public<\/span> static<\/span> class<\/span> WebApiConfig<\/pre>\n
<\/p>\n
   6:<\/span>     {<\/pre>\n
<\/p>\n
   7:<\/span>         public<\/span> static<\/span> void<\/span> Register(HttpConfiguration config)<\/pre>\n
<\/p>\n
   8:<\/span>         {<\/pre>\n
<\/p>\n
   9:<\/span>             \/\/ Web API configuration and services<\/span><\/pre>\n
<\/p>\n
  10:<\/span>  <\/pre>\n
<\/p>\n
  11:<\/span>             \/\/ Web API routes<\/span><\/pre>\n
<\/p>\n
  12:<\/span>             config.MapHttpAttributeRoutes();<\/pre>\n
<\/p>\n
  13:<\/span>  <\/pre>\n
<\/p>\n
  14:<\/span>             config.Routes.MapHttpRoute(<\/pre>\n
<\/p>\n
  15:<\/span>                 name: "DefaultApi"<\/span>,<\/pre>\n
<\/p>\n
  16:<\/span>                 routeTemplate: "api\/{controller}\/{id}"<\/span>,<\/pre>\n
<\/p>\n
  17:<\/span>                 defaults: new<\/span> { id = RouteParameter.Optional }<\/pre>\n
<\/p>\n
  18:<\/span>             );<\/pre>\n
<\/p>\n
  19:<\/span>  <\/pre>\n
<\/p>\n
  20:<\/span>             \/\/ Load Salesforce receiver<\/span><\/pre>\n
<\/p>\n
  21:<\/span>             config.InitializeReceiveSalesforceWebHooks();<\/pre>\n
<\/p>\n
  22:<\/span>         }<\/pre>\n
<\/p>\n
  23:<\/span>     }<\/pre>\n
<\/p>\n
  24:<\/span> }<\/pre>\n
<\/div>\n<\/div>\n
Set the MS_WebHookReceiverSecret_SalesforceSoap<\/strong> application setting to the value of your Organizational ID<\/strong> which you can find on the Setup<\/strong> page under Administer<\/strong> | Company Profile<\/strong> | Company Information<\/strong>:<\/p>\n
\"SalesforceOrgId\"<\/a><\/p>\n
As stated in the blog Introducing Microsoft ASP.NET WebHooks Preview<\/a>, the preferred way to do this is to set it in the Azure Portal:<\/p>\n
\"AzureAppSettings\"<\/a><\/p>\n
Defining a Handler<\/h3>\n
Let\u2019s define a handler that can process the incoming message from Salesforce \u2013 something like this will do:<\/p>\n
\n
\n
   1:<\/span> public<\/span> class<\/span> SalesforceHandler : WebHookHandler<\/pre>\n
<\/p>\n
   2:<\/span> {<\/pre>\n
<\/p>\n
   3:<\/span>     public<\/span> override<\/span> Task ExecuteAsync(string<\/span> receiver, WebHookHandlerContext context)<\/pre>\n
<\/p>\n
   4:<\/span>     {<\/pre>\n
<\/p>\n
   5:<\/span>         SalesforceNotifications updates = context.GetDataOrDefault<SalesforceNotifications>();<\/pre>\n
<\/p>\n
   6:<\/span>         string<\/span> sessionId = updates.SessionId;<\/pre>\n
<\/p>\n
   7:<\/span>         string<\/span> company = updates.Notifications.First()["Company"<\/span>];<\/pre>\n
<\/p>\n
   8:<\/span>         return<\/span> Task.FromResult(true<\/span>);<\/pre>\n
<\/p>\n
   9:<\/span>     }<\/pre>\n
<\/p>\n
  10:<\/span> }<\/pre>\n
<\/div>\n<\/div>\n
Trying it Out<\/h3>\n
After deploying your Web Application, we are now ready to try it out. Do this by creating a new Lead<\/strong> as follows: Go to the Leads<\/strong> menu and select New<\/strong>:<\/p>\n
\"SalesforceLeadsNew\"<\/a><\/p>\n
Then fill in the entry picking values that match the filter you set up for the Lead rule earlier and then hit Save<\/strong>.<\/p>\n
\"SalesForceLeadsEdit\"<\/a><\/p>\n
When running with the debugger attached you should see something like this:<\/p>\n
\"SalesforceRun\"<\/a><\/p>\n
The session ID is available for subsequent calls and you can inspect the data from the notification (or multiple notifications) as well.<\/p>\n
Finally, you can optionally inspect the delivery status of the messages by going to Build<\/strong> | Create<\/strong> | Workflow and Approvals<\/strong> | Outbound Messages<\/strong> and then select View Message Delivery Status<\/strong>. It should give you an overview of which messages were delivered:<\/p>\n
\"SalesforceDelivery\"<\/a><\/p>\n
That\u2019s it \u2013 have fun!<\/p>\n
Henrik<\/p>\n","protected":false},"excerpt":{"rendered":"
In the blog Introducing Microsoft ASP.NET WebHooks Preview, we gave an overview of how to work with Microsoft ASP.NET WebHooks. Out of the box we provide support for a variety of existing WebHooks providers such as Dropbox, GitHub, MailChimp, PayPal, Slack, Trello, and many more. Salesforce does not support classic WebHooks, but they do have […]<\/p>\n","protected":false},"author":403,"featured_media":58792,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[197],"tags":[34,7505,7506],"class_list":["post-5901","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-aspnet","tag-asp-net-web-api","tag-asp-net-webhooks","tag-webhooks"],"acf":[],"blog_post_summary":"
In the blog Introducing Microsoft ASP.NET WebHooks Preview, we gave an overview of how to work with Microsoft ASP.NET WebHooks. Out of the box we provide support for a variety of existing WebHooks providers such as Dropbox, GitHub, MailChimp, PayPal, Slack, Trello, and many more. Salesforce does not support classic WebHooks, but they do have […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/posts\/5901","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/users\/403"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/comments?post=5901"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/posts\/5901\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/media\/58792"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/media?parent=5901"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/categories?post=5901"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/tags?post=5901"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}