{"id":1129,"date":"2018-11-30T14:00:21","date_gmt":"2018-11-30T08:30:21","guid":{"rendered":"http:\/\/www.connecto.io\/kb\/?p=1129"},"modified":"2020-01-15T11:49:04","modified_gmt":"2020-01-15T06:19:04","slug":"how-to-send-segmented-notification-through-api","status":"publish","type":"post","link":"https:\/\/www.connecto.io\/kb\/uncategorized\/how-to-send-segmented-notification-through-api\/","title":{"rendered":"How to Send Segmented Notification through API"},"content":{"rendered":"

Segmented notification can be send from app.connecto.io and through API.<\/em><\/p>\n

Please follow the steps to send segmented notification through API.<\/em><\/p>\n

API\u00a0<\/strong> :\u00a0\u00a0http:\/\/app.connecto.io\/send\/chromePushNotificationApi<\/p>\n

Example : You want to send Notification to target users : who have submitted lead with city_name equals jaipur\u00a0or visited page ‘\/’ having attribute model_name equals Honda in last 7days.<\/p>\n

payload for Segmented Notification API.<\/strong><\/p>\n

{<\/div>\n
\u00a0 “writekey”: “XXXXX”,<\/div>\n
\u00a0 “projectId”: “abcdefghijklmnnopq”,<\/div>\n
\u00a0 “propertyId” : ”1123456789123456″,<\/div>\n
\u00a0 “campaignId” : “5b6c13d6a5486b438c81c57c”,<\/div>\n
\u00a0 “notification”: {<\/div>\n
\u00a0 \u00a0 “name”: “Notification_Name”,<\/div>\n
\u00a0 \u00a0 “title”: “Notification title”,<\/div>\n
\u00a0 \u00a0 “type”: 1,<\/div>\n
\u00a0 \u00a0 “badge”: “”,<\/div>\n
\u00a0 \u00a0 “message”: “planning to buy Car- 2018”,<\/div>\n
\u00a0 \u00a0 “targetUrl”: “https:\/\/www.connecto.io\/<\/a>“,<\/div>\n
“icon” :”https:\/\/stimg.cardekho.com\/pwa\/img\/cardekho-221X37.png<\/a>“,<\/div>\n
\u00a0“segment”:{<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 “windowStart” : 7,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 “windowEnd” : 0,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 “isActive” : true,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 “computationMode” : “offline”,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 “orRules” : [<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “andRules” : [<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “rule” : {<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “eventText” : “Lead”,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “attributeKey” : [<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “City”<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 ],<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “attributeValue” : [<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “jaipur”<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 ],<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “attributeMatchType” : [<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 0<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 ]<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 },<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “hasDone” : true,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “type” : 0<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 ]<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 },<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “andRules” : [<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “rule” : {<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “urlMatchValue” : “\/”,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “attributeKey” : [<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “brand”<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 ],<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “attributeValue” : [<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “Honda”<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 ],<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “attributeMatchType” : [<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 0<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 ]<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 },<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “hasDone” : true,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “type” : 1<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 ]<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 ]<\/div>\n
\u00a0 \u00a0 }<\/div>\n
\u00a0 }<\/div>\n
}<\/div>\n
    \n
  • writekey, projectId, propertyId can be found on settings page of app.connecto.io.<\/em><\/span><\/li>\n
  • campaignId: campaignId is same as notificationId .\u00a0<\/em><\/span><\/span><\/li>\n
  • Notification object contain\u00a0 some common attributes and some different attributes which get changed according to type of notification.<\/em><\/span>\n
    <\/div>\n
    Common attributes:\u00a0<\/strong><\/div>\n
    \n
    title: String,<\/div>\n
    name: String,<\/div>\n
    type : Number,\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \/\/ type can be (1\/3\/4\/5) according to type different attribute is used.<\/div>\n
    tag:String,\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0\/\/ tag is mandatory filed which should contain ‘connecto’ as\u00a0 value.<\/div>\n
    \n

    require_interaction : String,<\/p>\n

    isScheduled: Boolean,<\/div>\n
    schedule_time: “7\/25\/18 4:19 PM”, \/\/only if isScheduled is true<\/div>\n
    segmentIds :[“string”],<\/div>\n
    segment : {}<\/div>\n<\/div>\n
    <\/div>\n
    Different Attribute according to type of notification:<\/strong><\/div>\n
    <\/div>\n
    \n
    type:1 (plain Text)<\/div>\n
    <\/div>\n
    message:String,<\/div>\n
    targetUrl:\u00a0 String,<\/div>\n
    icon: String,<\/div>\n
    badge: String<\/div>\n<\/div>\n
    <\/div>\n
    type:3 (Text with one Action Button)<\/div>\n
    message:String,<\/div>\n
    targetUrl:\u00a0 String,<\/div>\n
    icon: String,<\/div>\n
    badge: String,<\/div>\n
    actionButtonText1: String,<\/div>\n
    targetUrl1:\u00a0 String,<\/div>\n
    imageUrl1: String<\/div>\n
    <\/div>\n
    type:4 (Text with two Action Button)<\/div>\n
    message:String,<\/div>\n
    targetUrl:\u00a0 String,<\/div>\n
    icon: String,<\/div>\n
    badge: String,<\/div>\n
    actionButtonText1: String,<\/div>\n
    targetUrl1:\u00a0 String,<\/div>\n
    imageUrl1: String,<\/div>\n
    actionButtonText2: String,<\/div>\n
    targetUrl2:\u00a0 String,<\/div>\n
    imageUrl2: String<\/div>\n
    <\/div>\n
    type:5 (Text with Banner)<\/div>\n
    message:String,<\/div>\n
    targetUrl:\u00a0 String,<\/div>\n
    icon: String,<\/div>\n
    badge: String<\/div>\n<\/div>\n
    <\/div>\n<\/li>\n
  • some details of keys inside Segemnt object:-<\/em><\/span>\n
    windowStart should be greater than windowEnd.<\/div>\n
    orRules\u00a0 is an array of\u00a0\u00a0andRules\u00a0objects.<\/div>\n
    andRules is an array of objects , where each object contain rule , hasDone(where true means executed and false means not-Executed) and type(1 means page view and 0 means Event ).<\/div>\n
    rule contains\u00a0attributeMatchType having two values.(0 means equals and\u00a0 1 means not equals ).<\/div>\n
    <\/div>\n
    \u00a0segemntvariable is one object inside andRules.<\/div>\n
    <\/div>\n
    Precaution:\u00a0 please don’t make a segment variable which contain attributeMatchType 1 .,i.e(not equals). It should contain atleast one 0 (equals ) case.<\/div>\n<\/li>\n<\/ul>\n
    \n
    Note:\u00a0campaignId is mandatory field in this payload. please use campaignId so that we can maintain impressions on this notification.<\/div>\n
    <\/div>\n<\/div>\n","protected":false},"excerpt":{"rendered":"

    Segmented notification can be send from app.connecto.io and through API. Please follow the steps to send segmented notification through API. API\u00a0 :\u00a0\u00a0http:\/\/app.connecto.io\/send\/chromePushNotificationApi Example : You want to send Notification to target users : who have submitted lead with city_name equals jaipur\u00a0or visited page ‘\/’ having attribute model_name equals Honda in last 7days. payload for Segmented Notification API. { \u00a0 “writekey”: “XXXXX”, \u00a0 “projectId”: “abcdefghijklmnnopq”, \u00a0 “propertyId” : ”1123456789123456″, \u00a0 “campaignId” : “5b6c13d6a5486b438c81c57c”, \u00a0 “notification”: { \u00a0 \u00a0 “name”: “Notification_Name”, \u00a0 […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-1129","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"_links":{"self":[{"href":"https:\/\/www.connecto.io\/kb\/wp-json\/wp\/v2\/posts\/1129","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.connecto.io\/kb\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.connecto.io\/kb\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.connecto.io\/kb\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.connecto.io\/kb\/wp-json\/wp\/v2\/comments?post=1129"}],"version-history":[{"count":13,"href":"https:\/\/www.connecto.io\/kb\/wp-json\/wp\/v2\/posts\/1129\/revisions"}],"predecessor-version":[{"id":1220,"href":"https:\/\/www.connecto.io\/kb\/wp-json\/wp\/v2\/posts\/1129\/revisions\/1220"}],"wp:attachment":[{"href":"https:\/\/www.connecto.io\/kb\/wp-json\/wp\/v2\/media?parent=1129"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.connecto.io\/kb\/wp-json\/wp\/v2\/categories?post=1129"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.connecto.io\/kb\/wp-json\/wp\/v2\/tags?post=1129"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}