SMS Webhooks

Introduction

Marketing Edge SMS Webhooks allows you to register endpoints to receive HTTP requests with SMS Data. You can create new Webhooks by configuring them within the Marketing Edge portal. Note that this requires Administrator access.

Types of SMS Webhooks

SMS Conversation Start - The SMS conversation start webhook executes immediately upon receiving the first message to a Tracking Number to any SMS feature enabled, and will only trigger on the first message recieved by a CTN for each distinct Texter. The payload will contain name/address matching details (when available), as well as attribution information obtained from Dynamic Number Insertion and Lead Tracking.

SMS Log Only - The SMS Log Only webhook executes immediately upon receiving the first message to a Tracking Number with the Log Only SMS feature enabled, and will trigger on every message recieved by that CTN. The payload will contain name/address matching details (when available), as well as attribution information obtained from Dynamic Number Insertion and Lead Tracking.

Configuration

You can also configure webhooks within the client account under the “Settings” -> “Webhooks” menu.

Sample Response

{
   "Id":"0d6d5db4-df30-46d5-aabe-a502b206453b",
   "Attempt":1,
   "Properties":{
      "CollectionType":"SmsDetails",
      "UTC":"datetime",
      "Organization":"int",
      "RequestId":"string"
   },
   "Notifications":[
      {
         "Action":"SmsDetails.SmsConversationStart",
         "ConversationId":"string",
         "StartTime":"datetime",
         "EndTime":"datetime",
         "TelmetricsStudyID":"int",
         "TexterNumber":"string",
         "TextedNumber":"string",
         "ConversationType":"string",
         "SmsToChatProvider":"string",
         "TexterName":"string",
         "TexterAddress":"string",
         "TexterCity":"string",
         "TexterState":"string",
         "TexterZip":"string",
         "OrgGroupName":"string",
         "OrganizationId":"int",
         "OrgGroupId":"int",
         "Longitude":"float",
         "Latitude":"float",
         "ConversationStartMessage":"string",
         "StudyDetails":{
            "StudyID":"int",
            "CustomID":"string",
            "CustomText":"string",
            "CustomText2":"string",
            "CustomText3":"string"
         },
         "AdvertiserDetails":{
            "AdvertiserID":"int",
            "ClientCode":"string",
            "CustomText":"string",
            "CustomText2":"string"
         },
         "AttributionDetails":{
            "SessionId":"guid",
            "RuleDescription":"string",
            "LandingPageUrl":"string",
            "ReferrerUrl":"string",
            "MultisessionFlag":"bool",
            "ip_address":"string",
            "user_agent":"string",
            "utm_campaign":"string",
            "utm_term":"string",
            "utm_source":"string",
            "utm_medium":"string",
            "utm_content":"string",
            "sesssion_tag":{
               "tag_id":"long",
               "tag_data":"string",
               "tag_date":"datetime"
            },
            "device_longitude":"decimal",
            "device_latitude":"decimal",
            "root_dnisessionstudyid":"long",
            "sessiondata":"string",
            "page_variables":"string",
            "GoogleAnalytics":{
               "TrackingId":"string",
               "UserId":"string",
               "CampaignMedium":"string",
               "ClientId":"string",
               "Referrer":"string",
               "Location":"string",
               "Page":"string",
               "ScreenResolution":"string",
               "ScreenColors":"string",
               "ViewportSize":"string",
               "FlashVersion":"string",
               "Encoding":"string",
               "JavaEnabled":"string",
               "Language":"string",
               "Dimension1":"string",
               "Dimension2":"string",
               "Dimension3":"string",
               "Dimension4":"string",
               "Dimension5":"string",
               "Dimension6":"string",
               "Dimension7":"string",
               "Dimension8":"string",
               "Dimension9":"string",
               "Dimension10":"string",
               "Dimension11":"string",
               "Dimension12":"string",
               "Dimension13":"string",
               "Dimension14":"string",
               "Dimension15":"string",
               "Dimension16":"string",
               "Dimension17":"string",
               "Dimension18":"string",
               "Dimension19":"string",
               "Dimension20":"string",
               "HitType":"string"
            },
            "AdobeAnalytics":{
               "Channel":"string",
               "VisitorId":"string",
               "Campaign":"string",
               "PageName":"string"
            }
         },
         "AdDetails":{
            "AdDefinitionID":"int",
            "CustomID":"string",
            "CustomText":"string",
            "CustomText2":"string",
            "CustomText3":"string",
            "CustomText4":"string"
         }
      }
   ]
}

{
   "Id":"0d6d5db4-df30-46d5-aabe-a502b206453b",
   "Attempt":1,
   "Properties":{
      "CollectionType":"SmsDetails",
      "UTC":"datetime",
      "Organization":"int",
      "RequestId":"string"
   },
   "Notifications":[
      {
         "Action":"SmsDetails.SmsLogOnlyRelay",
         "ConversationId":"string",
         "StartTime":"datetime",
         "EndTime":"datetime",
         "TelmetricsStudyID":"int",
         "TexterNumber":"string",
         "TextedNumber":"string",
         "ConversationType":"string",
         "SmsToChatProvider":"string",
         "TexterName":"string",
         "TexterAddress":"string",
         "TexterCity":"string",
         "TexterState":"string",
         "TexterZip":"string",
         "OrgGroupName":"string",
         "OrganizationId":"int",
         "OrgGroupId":"int",
         "Longitude":"float",
         "Latitude":"float",
         "Message":"string",
         "StudyDetails":{
            "StudyID":"int",
            "CustomID":"string",
            "CustomText":"string",
            "CustomText2":"string",
            "CustomText3":"string"
         },
         "AdvertiserDetails":{
            "AdvertiserID":"int",
            "ClientCode":"string",
            "CustomText":"string",
            "CustomText2":"string"
         },
         "AttributionDetails":{
            "SessionId":"guid",
            "RuleDescription":"string",
            "LandingPageUrl":"string",
            "ReferrerUrl":"string",
            "MultisessionFlag":"bool",
            "ip_address":"string",
            "user_agent":"string",
            "utm_campaign":"string",
            "utm_term":"string",
            "utm_source":"string",
            "utm_medium":"string",
            "utm_content":"string",
            "sesssion_tag":{
               "tag_id":"long",
               "tag_data":"string",
               "tag_date":"datetime"
            },
            "device_longitude":"decimal",
            "device_latitude":"decimal",
            "root_dnisessionstudyid":"long",
            "sessiondata":"string",
            "page_variables":"string",
            "GoogleAnalytics":{
               "TrackingId":"string",
               "UserId":"string",
               "CampaignMedium":"string",
               "ClientId":"string",
               "Referrer":"string",
               "Location":"string",
               "Page":"string",
               "ScreenResolution":"string",
               "ScreenColors":"string",
               "ViewportSize":"string",
               "FlashVersion":"string",
               "Encoding":"string",
               "JavaEnabled":"string",
               "Language":"string",
               "Dimension1":"string",
               "Dimension2":"string",
               "Dimension3":"string",
               "Dimension4":"string",
               "Dimension5":"string",
               "Dimension6":"string",
               "Dimension7":"string",
               "Dimension8":"string",
               "Dimension9":"string",
               "Dimension10":"string",
               "Dimension11":"string",
               "Dimension12":"string",
               "Dimension13":"string",
               "Dimension14":"string",
               "Dimension15":"string",
               "Dimension16":"string",
               "Dimension17":"string",
               "Dimension18":"string",
               "Dimension19":"string",
               "Dimension20":"string",
               "HitType":"string"
            },
            "AdobeAnalytics":{
               "Channel":"string",
               "VisitorId":"string",
               "Campaign":"string",
               "PageName":"string"
            }
         },
         "AdDetails":{
            "AdDefinitionID":"int",
            "CustomID":"string",
            "CustomText":"string",
            "CustomText2":"string",
            "CustomText3":"string",
            "CustomText4":"string"
         }
      }
   ]
}