Templates

Learn how to configure Templates for your app. This page includes descriptions and examples for defining Templates in a Kustomer app.

Templates are an outline of different features within Kustomer that give you a useful starting point to use right away or modify that template to a more specific use case for you.

Apps can currently configure Business Rules and Reporting Charts templates.

πŸ“˜

Note

We currently recommend that you use the Kustomer UI to generate templates, then copying and pasting the response in the network console to be added to your app. We understand that this may be difficult, so if you need support using these app-installed templates, please contact [email protected].

Templates format in the app definition

The templates property takes an object of properties that define the following for each template category. Each category then has an array of templates that define the following for each template.

Templates definition example

The following sample JSON app definition includes a templates property definition that creates and configures Business Rules and Charts templates in Kustomer.

{
   "app":"ecommstore",
   "version":"0.0.1",
   "title":"E-comm Store",
   "templates":{
      "charts":[
         {
            "title":"Example Chart Template Title",
            "description":"Chart template description example.",
            "category":"Apps",
            "templateId":"example-chart-template",
            "labels":[
               {
                  "axis":{
                     "y":"",
                     "x":""
                  }
               }
            ],
            "queries":[
               {
                  "chartType":"datatable",
                  "queryContext":"conversation",
                  "data":{
                     "interval":"week",
                     "metrics":[
                        {
                           "field":"conversation_updated_at",
                           "type":"conversations_over_time",
                           "metrics":[
                              {
                                 "field":"conversation_prediction_corrected_by",
                                 "type":"conversations_term"
                              }
                           ]
                        }
                     ],
                     "range":{
                        "field":"conversation_updated_at"
                     },
                     "query":{
                        "and":[
                           {
                              "conversation_prediction_corrected_by":{
                                 "is_set":true
                              }
                           },
                           {
                              "conversation_prediction_status":{
                                 "equals":"corrected"
                              }
                           }
                        ],
                        "or":[
                           
                        ]
                     }
                  }
               }
            ]
         }
      ],
      "bizRules":[
         {
            "id":"example-bizRules-template",
            "pillIcon":"check",
            "pillType":"success",
            "title":"Example Biz Rules Title",
            "description":"Biz Rules template description example. This is a very long description to see how it would look on the UI",
            "category":"add_tag",
            "data":{
               "templateId":"example-bizRules-template",
               "name":"Example Name"
            }
         }
      ]
   }
}

Templates properties

The basic templates definition properties and their descriptions are listed below:

charts

Optional. An array with the following object as a Chart:

Example:

{
   "title":"Example Chart Template Title",
   "description":"Chart template description example.",
   "category":"Apps",
   "templateId":"example-chart-template",
   "labels":[
      {
         "axis":{
            "y":"",
            "x":""
         }
      }
   ],
   "queries":[
      {
         "chartType":"datatable",
         "queryContext":"conversation",
         "data":{
            "interval":"week",
            "metrics":[
               {
                  "field":"conversation_updated_at",
                  "type":"conversations_over_time",
                  "metrics":[
                     {
                        "field":"conversation_prediction_corrected_by",
                        "type":"conversations_term"
                     }
                  ]
               }
            ],
            "range":{
               "field":"conversation_updated_at"
            },
            "query":{
               "and":[
                  {
                     "conversation_prediction_corrected_by":{
                        "is_set":true
                     }
                  },
                  {
                     "conversation_prediction_status":{
                        "equals":"corrected"
                     }
                  }
               ],
               "or":[
                  
               ]
            }
         }
      }
   ]
}

bizRules

Optional. An array with the following object as a Business Rule:

Example:

{
   "id":"example-biz-rule-template",
   "title":"Example Biz Rule Template Title",
   "description":"Biz rule template description example",
   "data":{
      "templateId":"example-biz-rule-template",
      "name":"Example Biz Rule Template Title",
      "description":"Biz rule template description example",
      "trigger":"kustomer.conversation.update",
      "eventTrigger":"conversation.first_inbound_message",
      "criteria":{
         "and":[
            {
               "conversation_importedAt":{
                  "operator":"not_set"
               }
            }
         ],
         "or":[
            
         ]
      },
      "actions":[
         {
            "type":"draft",
            "app":"kustomer",
            "input":{
               "drafts":[
                  {
                     "body":"Hello {{customer.name}},\n\nThank you for contacting us. Someone will be with you shortly.\n\nThank you!",
                     "channel":"email",
                     "from":"",
                     "template":null,
                     "templateType":"email-reply"
                  }
               ]
            }
         }
      ],
      "enabled":false
   },
   "isVisibleOnPage":true,
   "category":"send_message",
   "categoryName":"category name",
   "pillIcon":"email",
   "pillType":"complete"
}

assistants

Optional. An array with the following object as a Conversational Assistant:

Example:

{
    "name": "product_quiz_lite",
    "templateId": "product_quiz_lite",
    "assistantType": "lite",
    "title": "Product Quiz - Lite Version",
    "category": "quiz",
    "description": "description",
    "dependencies": [],
    "variants": [
        {
            "name": "Product Quiz - Lite Version",
            "type": "lite",
            "publicName": "",
            "description": "",
            "channel": "chat",
            "start": "62caa99813f15ad960c79223",
            "dialogs": [
                {
                    "id": "62caa99813f15ad960c79223",
                    "name": "Welcome",
                    "nodes": [
                        {
                            "id": "62caa99813f15a472ec79229",
                            "type": "message",
                            "attributes": {
                                "text": "πŸ‘‹ Hi {{ or customer.firstName β€œthere”}}\n\nI'm the Store assistant, I can help you with choosing the right product for you, or redirect you to the right person ",
                                "draftJs": {
                                    "blocks": [
                                        {
                                            "text": "πŸ‘‹ Hi {{ or customer.firstName β€œthere”}}",
                                            "key": "8c0ih",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "",
                                            "key": "28kar",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "I'm the Store assistant, I can help you with choosing the right product for you, or redirect you to the right person ",
                                            "key": "5m3qm",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        }
                                    ],
                                    "entityMap": {}
                                }
                            }
                        },
                        {
                            "id": "ZW7hdcR1r",
                            "type": "action",
                            "attributes": {
                                "subtype": "redirect",
                                "next": {
                                    "assistantId": "62cfdb1d75ac6359a1880f87",
                                    "dialogId": "oKwbYtp2NH"
                                }
                            }
                        }
                    ]
                },
                {
                    "id": "oKwbYtp2NH",
                    "name": "Main Menu",
                    "nodes": [
                        {
                            "id": "xXRKBYgOH",
                            "type": "question",
                            "attributes": {
                                "text": "How can I help you today? ",
                                "response_type": "multi_select",
                                "response_template": "navigation_menu",
                                "set_attribute": false,
                                "set_attribute_class": null,
                                "actions": [
                                    {
                                        "type": "quick_reply",
                                        "id": "Jv-Xp3hkZY",
                                        "label": "🧩 Product quiz",
                                        "payload": "🧩 Product quiz",
                                        "next": {
                                            "assistantId": "62cfdb1d75ac6359a1880f87",
                                            "dialogId": "3n-KNSMSm"
                                        }
                                    },
                                    {
                                        "type": "quick_reply",
                                        "id": "0ad2Agqs3",
                                        "label": "❓Something Else",
                                        "payload": "❓Something Else",
                                        "next": {
                                            "assistantId": "62cfdb1d75ac6359a1880f87",
                                            "dialogId": "rW1ktoAKR"
                                        }
                                    },
                                    {
                                        "type": "quick_reply",
                                        "id": "dxvx-Um9H",
                                        "label": "πŸ‘¨β€πŸ’» Talk with an Agent ",
                                        "payload": "πŸ‘¨β€πŸ’» Talk with an Agent ",
                                        "next": {
                                            "assistantId": "62cfdb1d75ac6359a1880f87",
                                            "dialogId": "62caa99813f15a152dc79227"
                                        }
                                    }
                                ],
                                "draftJs": {
                                    "blocks": [
                                        {
                                            "text": "How can I help you today? ",
                                            "key": "bd9pv",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        }
                                    ],
                                    "entityMap": {}
                                }
                            }
                        }
                    ]
                },
                {
                    "id": "3n-KNSMSm",
                    "name": "Product Quiz",
                    "nodes": [
                        {
                            "id": "DLYAU-Tn5",
                            "type": "question",
                            "attributes": {
                                "text": "Do you want your \\[product\\] with \\[Feature\\]? ",
                                "response_type": "multi_select",
                                "response_template": "static_option",
                                "set_attribute": true,
                                "set_attribute_class": "conversation",
                                "actions": [
                                    {
                                        "type": "quick_reply",
                                        "id": "airSPQabYy",
                                        "label": "πŸ‘",
                                        "payload": "πŸ‘"
                                    },
                                    {
                                        "type": "quick_reply",
                                        "id": "cO00_2oUb",
                                        "label": "πŸ‘Ž",
                                        "payload": "πŸ‘Ž"
                                    }
                                ],
                                "draftJs": {
                                    "blocks": [
                                        {
                                            "text": "Do you want your [product] with [Feature]? ",
                                            "key": "7rg0q",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        }
                                    ],
                                    "entityMap": {}
                                },
                                "set_attribute_field": "caStepValueStr"
                            }
                        },
                        {
                            "id": "8WutTTYBm",
                            "type": "conditional",
                            "attributes": {
                                "conditions": [
                                    {
                                        "id": "v07vq4eSXc",
                                        "type": "condition",
                                        "actions": [
                                            {
                                                "id": "9_2BWzkG5",
                                                "type": "action",
                                                "attributes": {
                                                    "subtype": "redirect",
                                                    "next": {
                                                        "assistantId": "62cfdb1d75ac6359a1880f87",
                                                        "dialogId": "Z8WJqFU2-"
                                                    }
                                                }
                                            }
                                        ],
                                        "criteria": {
                                            "and": [
                                                {
                                                    "conversation_custom_caStepValueStr": {
                                                        "operator": "equals",
                                                        "value": "πŸ‘"
                                                    }
                                                }
                                            ],
                                            "or": []
                                        }
                                    }
                                ],
                                "default": []
                            }
                        },
                        {
                            "id": "b-s-oFfIx",
                            "type": "question",
                            "attributes": {
                                "text": "Do you want your \\[product\\] with \\[Feature 2\\]? ",
                                "response_type": "multi_select",
                                "response_template": "static_option",
                                "set_attribute": true,
                                "set_attribute_class": "conversation",
                                "actions": [
                                    {
                                        "type": "quick_reply",
                                        "id": "uT3embkb7W",
                                        "label": "πŸ‘",
                                        "payload": "πŸ‘"
                                    },
                                    {
                                        "type": "quick_reply",
                                        "id": "m8Ej7naid",
                                        "label": "πŸ‘Ž",
                                        "payload": "πŸ‘Ž"
                                    }
                                ],
                                "draftJs": {
                                    "blocks": [
                                        {
                                            "text": "Do you want your [product] with [Feature 2]? ",
                                            "key": "a9olb",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        }
                                    ],
                                    "entityMap": {}
                                },
                                "set_attribute_field": "caStepValueStr"
                            }
                        },
                        {
                            "id": "GkaAFOO5e",
                            "type": "conditional",
                            "attributes": {
                                "conditions": [
                                    {
                                        "id": "JYD2AIDRqY",
                                        "type": "condition",
                                        "actions": [
                                            {
                                                "id": "Bb5NNELQc",
                                                "type": "action",
                                                "attributes": {
                                                    "subtype": "redirect",
                                                    "next": {
                                                        "assistantId": "62cfdb1d75ac6359a1880f87",
                                                        "dialogId": "bEvSGxUkO"
                                                    }
                                                }
                                            }
                                        ],
                                        "criteria": {
                                            "and": [
                                                {
                                                    "conversation_custom_caStepValueStr": {
                                                        "operator": "equals",
                                                        "value": "πŸ‘"
                                                    }
                                                }
                                            ],
                                            "or": []
                                        }
                                    }
                                ],
                                "default": []
                            }
                        },
                        {
                            "id": "u4RwlVLB-",
                            "type": "question",
                            "attributes": {
                                "text": "Do you prefer a small \\[feature\\] or biggest one? ",
                                "response_type": "multi_select",
                                "response_template": "static_option",
                                "set_attribute": true,
                                "set_attribute_class": "conversation",
                                "actions": [
                                    {
                                        "type": "quick_reply",
                                        "id": "kVhnpldi7V",
                                        "label": "πŸ“Ÿ Small",
                                        "payload": "πŸ“Ÿ Small"
                                    },
                                    {
                                        "type": "quick_reply",
                                        "id": "sQOZ69I9G",
                                        "label": "πŸ“Ί Big ",
                                        "payload": "πŸ“Ί Big "
                                    }
                                ],
                                "draftJs": {
                                    "blocks": [
                                        {
                                            "text": "Do you prefer a small [feature] or biggest one? ",
                                            "key": "3s5qm",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        }
                                    ],
                                    "entityMap": {}
                                },
                                "set_attribute_field": "caStepValueStr"
                            }
                        },
                        {
                            "id": "VLYGqMThH",
                            "type": "conditional",
                            "attributes": {
                                "conditions": [
                                    {
                                        "id": "nhZDyIDRsm",
                                        "type": "condition",
                                        "actions": [
                                            {
                                                "id": "r5H8eA4rD",
                                                "type": "action",
                                                "attributes": {
                                                    "subtype": "redirect",
                                                    "next": {
                                                        "assistantId": "62cfdb1d75ac6359a1880f87",
                                                        "dialogId": "f6uy60FVQ"
                                                    }
                                                }
                                            }
                                        ],
                                        "criteria": {
                                            "and": [
                                                {
                                                    "conversation_custom_caStepValueStr": {
                                                        "operator": "equals",
                                                        "value": "πŸ“Ÿ Small"
                                                    }
                                                }
                                            ],
                                            "or": []
                                        }
                                    }
                                ],
                                "default": [
                                    {
                                        "id": "iTbJkaVOB",
                                        "type": "action",
                                        "attributes": {
                                            "subtype": "redirect",
                                            "next": {
                                                "assistantId": "62cfdb1d75ac6359a1880f87",
                                                "dialogId": "D4TI3DOX0"
                                            }
                                        }
                                    }
                                ]
                            }
                        }
                    ]
                },
                {
                    "id": "Z8WJqFU2-",
                    "name": "ANS - Product 1",
                    "nodes": [
                        {
                            "id": "AqUGuKAEM",
                            "type": "question",
                            "attributes": {
                                "text": "**\\[Product 1\\]**\n\n\\[Product 1 main description\\]\n\n- \\[Product feature \\#1\\]\n- \\[Product feature \\#2\\]\n- \\[Product feature \\#3\\] \n\n[πŸ“– More Info](http://www.google.com)​\n ",
                                "response_type": "multi_select",
                                "response_template": "navigation_menu",
                                "set_attribute": false,
                                "set_attribute_class": null,
                                "actions": [
                                    {
                                        "type": "quick_reply",
                                        "id": "ENG9eIvCrW",
                                        "label": "πŸ‘ Helpfull",
                                        "payload": "πŸ‘ Helpfull",
                                        "next": {
                                            "assistantId": "62cfdb1d75ac6359a1880f87",
                                            "dialogId": "oKwbYtp2NH"
                                        }
                                    },
                                    {
                                        "type": "quick_reply",
                                        "id": "Al_ZCW1DHi",
                                        "label": "πŸ‘Ž Still need help",
                                        "payload": "πŸ‘Ž Still need help",
                                        "next": {
                                            "assistantId": "62cfdb1d75ac6359a1880f87",
                                            "dialogId": "62caa99813f15a152dc79227"
                                        }
                                    }
                                ],
                                "draftJs": {
                                    "blocks": [
                                        {
                                            "text": "[Product 1]",
                                            "key": "e4983",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [
                                                {
                                                    "offset": 0,
                                                    "length": 11,
                                                    "style": "BOLD"
                                                }
                                            ],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "",
                                            "key": "78hmc",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "[Product 1 main description]",
                                            "key": "fs4d2",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "",
                                            "key": "dtmjo",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "[Product feature #1]",
                                            "key": "1o19m",
                                            "type": "unordered-list-item",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "[Product feature #2]",
                                            "key": "8m7s8",
                                            "type": "unordered-list-item",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "[Product feature #3] ",
                                            "key": "bis0e",
                                            "type": "unordered-list-item",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "πŸ“– More Info​​",
                                            "key": "4rskk",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": [
                                                {
                                                    "offset": 0,
                                                    "length": 12,
                                                    "key": 0
                                                }
                                            ]
                                        },
                                        {
                                            "text": " ",
                                            "key": "acovs",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        }
                                    ],
                                    "entityMap": {
                                        "0": {
                                            "type": "LINK",
                                            "mutability": "MUTABLE",
                                            "data": {
                                                "url": "http://www.google.com"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    ]
                },
                {
                    "id": "bEvSGxUkO",
                    "name": "ANS - Product 2",
                    "nodes": [
                        {
                            "id": "BfSpHPrXNT",
                            "type": "question",
                            "attributes": {
                                "text": "**\\[Product 2\\]**\n\n\\[Product 2 main description\\]\n\n- \\[Product feature \\#1\\]\n- \\[Product feature \\#2\\]\n- \\[Product feature \\#3\\]\n\n[πŸ“– More Info](http://www.google.com/)​​ ",
                                "response_type": "multi_select",
                                "response_template": "navigation_menu",
                                "set_attribute": false,
                                "set_attribute_class": null,
                                "actions": [
                                    {
                                        "type": "quick_reply",
                                        "id": "LRrGR2IV3h",
                                        "label": "πŸ‘ Helpfull",
                                        "payload": "πŸ‘ Helpfull",
                                        "next": {
                                            "assistantId": "62cfdb1d75ac6359a1880f87",
                                            "dialogId": "oKwbYtp2NH"
                                        }
                                    },
                                    {
                                        "type": "quick_reply",
                                        "id": "z-_MeaaFtH",
                                        "label": "πŸ‘Ž Still need help",
                                        "payload": "πŸ‘Ž Still need help",
                                        "next": {
                                            "assistantId": "62cfdb1d75ac6359a1880f87",
                                            "dialogId": "62caa99813f15a152dc79227"
                                        }
                                    }
                                ],
                                "draftJs": {
                                    "blocks": [
                                        {
                                            "text": "[Product 2]",
                                            "key": "e4983",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [
                                                {
                                                    "offset": 0,
                                                    "length": 11,
                                                    "style": "BOLD"
                                                }
                                            ],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "",
                                            "key": "7tv9d",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "[Product 2 main description]",
                                            "key": "dli0p",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "",
                                            "key": "12ibj",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "[Product feature #1]",
                                            "key": "3sdu1",
                                            "type": "unordered-list-item",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "[Product feature #2]",
                                            "key": "3posa",
                                            "type": "unordered-list-item",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "[Product feature #3]",
                                            "key": "4p9fg",
                                            "type": "unordered-list-item",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "πŸ“– More Info​​ ",
                                            "key": "dfbib",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": [
                                                {
                                                    "offset": 0,
                                                    "length": 12,
                                                    "key": 0
                                                }
                                            ]
                                        }
                                    ],
                                    "entityMap": {
                                        "0": {
                                            "type": "LINK",
                                            "mutability": "MUTABLE",
                                            "data": {
                                                "href": "http://www.google.com/",
                                                "url": "http://www.google.com/"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    ]
                },
                {
                    "id": "f6uy60FVQ",
                    "name": "ANS - Product 3",
                    "nodes": [
                        {
                            "id": "McGuEyKfV0",
                            "type": "question",
                            "attributes": {
                                "text": "**\\[Product 3\\]**\n\n\\[Product 3 main description\\]\n\n- \\[Product feature \\#1\\]\n- \\[Product feature \\#2\\]\n- \\[Product feature \\#3\\]\n\n[πŸ“– More Info](http://www.google.com/)​​ ",
                                "response_type": "multi_select",
                                "response_template": "navigation_menu",
                                "set_attribute": false,
                                "set_attribute_class": null,
                                "actions": [
                                    {
                                        "type": "quick_reply",
                                        "id": "rVo295Sjor",
                                        "label": "πŸ‘ Helpfull",
                                        "payload": "πŸ‘ Helpfull",
                                        "next": {
                                            "assistantId": "62cfdb1d75ac6359a1880f87",
                                            "dialogId": "oKwbYtp2NH"
                                        }
                                    },
                                    {
                                        "type": "quick_reply",
                                        "id": "IAmy_WZZJJ",
                                        "label": "πŸ‘Ž Still need help",
                                        "payload": "πŸ‘Ž Still need help",
                                        "next": {
                                            "assistantId": "62cfdb1d75ac6359a1880f87",
                                            "dialogId": "62caa99813f15a152dc79227"
                                        }
                                    }
                                ],
                                "draftJs": {
                                    "blocks": [
                                        {
                                            "text": "[Product 3]",
                                            "key": "e4983",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [
                                                {
                                                    "offset": 0,
                                                    "length": 11,
                                                    "style": "BOLD"
                                                }
                                            ],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "",
                                            "key": "e06qt",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "[Product 3 main description]",
                                            "key": "cs700",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "",
                                            "key": "6ibk",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "[Product feature #1]",
                                            "key": "dqlf8",
                                            "type": "unordered-list-item",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "[Product feature #2]",
                                            "key": "90ruq",
                                            "type": "unordered-list-item",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "[Product feature #3]",
                                            "key": "bf7jt",
                                            "type": "unordered-list-item",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "πŸ“– More Info​​ ",
                                            "key": "26s2k",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": [
                                                {
                                                    "offset": 0,
                                                    "length": 12,
                                                    "key": 0
                                                }
                                            ]
                                        }
                                    ],
                                    "entityMap": {
                                        "0": {
                                            "type": "LINK",
                                            "mutability": "MUTABLE",
                                            "data": {
                                                "href": "http://www.google.com/",
                                                "url": "http://www.google.com/"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    ]
                },
                {
                    "id": "D4TI3DOX0",
                    "name": "ANS - Product 4",
                    "nodes": [
                        {
                            "id": "6Bl9TwJjeJ",
                            "type": "question",
                            "attributes": {
                                "text": "**\\[Product 4\\]**\n\n\\[Product 4 main description\\]\n\n- \\[Product feature \\#1\\]\n- \\[Product feature \\#2\\]\n- \\[Product feature \\#3\\]\n\n[πŸ“– More Info](http://www.google.com/)​​ ",
                                "response_type": "multi_select",
                                "response_template": "navigation_menu",
                                "set_attribute": false,
                                "set_attribute_class": null,
                                "actions": [
                                    {
                                        "type": "quick_reply",
                                        "id": "MNK2_oTjMT",
                                        "label": "πŸ‘ Helpfull",
                                        "payload": "πŸ‘ Helpfull",
                                        "next": {
                                            "assistantId": "62cfdb1d75ac6359a1880f87",
                                            "dialogId": "oKwbYtp2NH"
                                        }
                                    },
                                    {
                                        "type": "quick_reply",
                                        "id": "xWpWDdfkn-",
                                        "label": "πŸ‘Ž Still need help",
                                        "payload": "πŸ‘Ž Still need help",
                                        "next": {
                                            "assistantId": "62cfdb1d75ac6359a1880f87",
                                            "dialogId": "62caa99813f15a152dc79227"
                                        }
                                    }
                                ],
                                "draftJs": {
                                    "blocks": [
                                        {
                                            "text": "[Product 4]",
                                            "key": "e4983",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [
                                                {
                                                    "offset": 0,
                                                    "length": 11,
                                                    "style": "BOLD"
                                                }
                                            ],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "",
                                            "key": "8at39",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "[Product 4 main description]",
                                            "key": "a4nn2",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "",
                                            "key": "c1dg9",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "[Product feature #1]",
                                            "key": "d0v3p",
                                            "type": "unordered-list-item",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "[Product feature #2]",
                                            "key": "eoahr",
                                            "type": "unordered-list-item",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "[Product feature #3]",
                                            "key": "1e7ko",
                                            "type": "unordered-list-item",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "πŸ“– More Info​​ ",
                                            "key": "9ag46",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": [
                                                {
                                                    "offset": 0,
                                                    "length": 12,
                                                    "key": 0
                                                }
                                            ]
                                        }
                                    ],
                                    "entityMap": {
                                        "0": {
                                            "type": "LINK",
                                            "mutability": "MUTABLE",
                                            "data": {
                                                "href": "http://www.google.com/",
                                                "url": "http://www.google.com/"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    ]
                },
                {
                    "id": "rW1ktoAKR",
                    "name": "Something Else",
                    "nodes": [
                        {
                            "id": "7DbctcN3U",
                            "type": "question",
                            "attributes": {
                                "text": "What do you need help with?",
                                "response_type": "free_text",
                                "set_attribute": false,
                                "set_attribute_class": null,
                                "actions": [],
                                "check_attribute_exists": false,
                                "draftJs": {
                                    "blocks": [
                                        {
                                            "text": "What do you need help with?",
                                            "key": "e7r57",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        }
                                    ],
                                    "entityMap": {}
                                }
                            }
                        },
                        {
                            "id": "CDR4JuGcc",
                            "type": "action",
                            "attributes": {
                                "subtype": "redirect",
                                "next": {
                                    "assistantId": "62cfdb1d75ac6359a1880f87",
                                    "dialogId": "62caa99813f15a152dc79227"
                                }
                            }
                        }
                    ]
                },
                {
                    "id": "62caa99813f15a152dc79227",
                    "name": "Ask Email + Handover",
                    "nodes": [
                        {
                            "id": "62caa99813f15ab848c7923a",
                            "type": "question",
                            "attributes": {
                                "text": "Before redirecting to our support team,\n\nWhat's your email? ",
                                "response_type": "free_text",
                                "set_attribute": true,
                                "set_attribute_class": "customer",
                                "actions": [],
                                "set_attribute_field": "email",
                                "draftJs": {
                                    "blocks": [
                                        {
                                            "text": "Before redirecting to our support team,",
                                            "key": "44ci2",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "",
                                            "key": "27gjf",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "What's your email? ",
                                            "key": "bm5da",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        }
                                    ],
                                    "entityMap": {}
                                },
                                "check_attribute_exists": true
                            }
                        },
                        {
                            "id": "iSR_pj86E",
                            "type": "question",
                            "attributes": {
                                "text": "Can I have your name?",
                                "response_type": "free_text",
                                "set_attribute": true,
                                "set_attribute_class": "customer",
                                "actions": [],
                                "check_attribute_exists": true,
                                "draftJs": {
                                    "blocks": [
                                        {
                                            "text": "Can I have your name?",
                                            "key": "hpdh",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        }
                                    ],
                                    "entityMap": {}
                                },
                                "set_attribute_field": "name"
                            }
                        },
                        {
                            "id": "UtksQziws",
                            "type": "message",
                            "attributes": {
                                "text": "We'll connect you with the team. If you leave the site, we'll follow up by email.\n​\n\nIn the meantime, please feel free to add any additional details.",
                                "draftJs": {
                                    "blocks": [
                                        {
                                            "text": "We'll connect you with the team. If you leave the site, we'll follow up by email.",
                                            "key": "9g1s8",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "​",
                                            "key": "c6rj1",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "",
                                            "key": "24b5v",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        },
                                        {
                                            "text": "In the meantime, please feel free to add any additional details.",
                                            "key": "fmb7c",
                                            "type": "unstyled",
                                            "depth": 0,
                                            "data": {},
                                            "inlineStyleRanges": [],
                                            "entityRanges": []
                                        }
                                    ],
                                    "entityMap": {}
                                }
                            }
                        },
                        {
                            "id": "62caa99813f15a796dc7923c",
                            "type": "action",
                            "attributes": {
                                "subtype": "transfer"
                            }
                        }
                    ]
                }
            ],
            "settings": {
                "abandonedChatEnabled": true,
                "idleChatEnabled": false,
                "transferOnAbandon": true,
                "markDoneOnAbandon": false,
                "volumeControlEnabled": false,
                "markDoneAfterTimeout": false,
                "useDynamicWaitMessage": false,
                "followUpChannels": [],
                "abandonedChatMessage": "[[sn.kustomer.assistant.vc_chat_abandoned_message]]",
                "missedChatMessage": "[[sn.kustomer.assistant.vc_agent_missed_message]]",
                "vcCompleteMessage": "[[sn.kustomer.assistant.vc_followup_message]]",
                "vcEmailFollowUpMessage": "[[sn.kustomer.assistant.email_followup]]",
                "vcPhoneFollowUpMessage": "[[sn.kustomer.assistant.phone_followup]]",
                "idleChatMessage": "[[sn.kustomer.assistant.vc_chat_idle_message]]"
            }
        }
    ]
}

Generate a template

Instead of trying to write a Kustomer template entirely from scratch, we recommend following these steps to create a template:

  1. Build a Chart, Business Rule or Conversational Assistant in Kustomer's corresponding feature.
  2. Select Create with the network tab open in the console.
  3. Copy the request body as your template.

Please reach out to [email protected] if you have any specific questions about generating templates in Kustomer.