Advanced customizations

Take advantage of Kustomer's platform through workflows and integrations with other tools.
Categories
  • Permissions required for common API requests

    To facilitate putting the principle of least privilege into practice, this article lists the narrowly-defined permissions needed to make some of the most common API requests. When multiple permissions are listed below a request, each listed permission alone grants access. Discretion should be exercised about which permission makes most sense to grant (i.e. user vs. admin) for your use case.CustomersGET: org.user.customer.readPATCH: org.user.customer.writePUT: org.user.customer.writePOST: org.user.customer.writeDELETE: org.admin.customer.deleteConversationsGET: org.user.conversation.readPATCH: org.user.conversation.writePUT: org.user.conversation.writePOST: org.user.conversation.writeDELETE: org.admin.conversation.deleteMessagesGET: org.user.message.readPATCH: org.user.message.writePUT: org.user.message.writePOST: org.user.message.writeKlassesGET (/klasses): org.user.klass.read, org.admin.klass.readGET (/klasses/{id}): org.user.kobject.readPUT: org.user.kobject.writePOST: org.user.kobject.writeDELETE: org.admin.kobject.deleteShortcutsGET (/shortcuts): org.user.klass.read, org.admin.klass.readGET (/shortcuts/{id}): org.user.klass.read, org.admin.klass.readPUT: org.admin.content.shortcut.write, org.admin.shortcut.writePOST: org.admin.content.shortcut.write, org.admin.shortcut.writeDELETE: org.admin.content.shortcut.write, org.admin.shortcut.writeSearchesThis endpoint is for searching via the API. POST: org.user.search.read, org.admin.search.readUsersGET (/users/current): org.admin.user.readPOST (/users/passwordreset): org.admin.user.writeTeamsGET: org.user.team.read, org.admin.team.readPOST: org.admin.team.write
  • Data payload examples

    Here are some JSON data payload examples for an order ingest or data connection, with comments for each section. Feel free to use this as a reference when sending in data payloads to a Kustomer webhook.These example payloads are some suggestions based on what we've seen orgs use in past implementations. We offer these as a frame of reference to help you see how other organizations set up Kustomer, and may not be 100% accurate or relevant to your Kustomer setup. Your payload does not have to include all of these attributes, or match the same attribute names.To learn more about importing data into Kustomer, please check out our help articles on Data Connect and Using Workflows to import data.Notes:Always ensure the object has a unique identifier order_number.Include an attribute for customer information, as this is needed to associate an order to the appropriate customer timeline.These examples include /* inline comments */ to illustrate functionality. You should remove these in production.{   "order_number": "AB-1234",   "created_at": "2019-05-04T05:47:31+10:00",   "status": "received",   /* section for order customer information */   "customer": {     "first_name": "Jane",     "last_name": "Doe",     "email": "janedoe@example.com",     "phone": "(555) 555-1234"   },   /* section for order shipping information */   "shipping": {     "address": {       "address1": "123 Main St",       "address2": "Apt 4",       "city": "Houston",       "state": "TX",       "country_code": "US",       "zip": "77001"     },     "method": {       "description": "Fast Shipping",       "carrier": "FedEx",       "carrier_code": "FDEG"     }   },   /* section for order billing information (if applicable) */   "billing_address": {     "address1": "123 Main St",     "address2": "Apt 4",     "city": "Houston",     "state": "TX",     "country_code": "US",     "zip": "77001"   },   /* section for order items */   "line_items": [{       "sku": "1234-01",       "item_name": "Test-Item",       "sku_name": "Test-Item-Sku",       "quantity": 1,       "weight": 1,       "sale_price": 9.99,       "subtotal": 0,       "sales_tax_collected": 0     },     {       "sku": "1234-02",       "item_name": "Test-Item 2",       "sku_name": "Test-Item-Sku-2",       "quantity": 1,       "weight": 1,       "sale_price": 9.99,       "subtotal": 0,       "sales_tax_collected": 0     }   ],   /* section for order cost information (if applicable) */   "totals": {     "items": 19.98,     "shipping": 11.98,     "additional shipping": 0,     "tax": 4.04,     "grand": 36   },   /* section for order payment details (if applicable) */   "payment_details": {     "brand": "Visa",     "last_4": "1234",     "status": "successful"   } }
  • Advanced customization for chat

    Chat allows you to customize chat settings for each brand in your organization from your Kustomer settings. You can configure the Kustomer Chat settings and the chat widget design from the Chat Management page without any custom code or developer resources.If your team would like to customize Kustomer Chat further, you can direct your developer team to the latest Kustomer Chat SDK documentation.Kustomer Chat Web SDKInstall, configure, and customize Kustomer Chat for your website or web app.Visit the Web SDK documentation.Kustomer Chat Mobile SDKsInstall, configure, and customize Kustomer Chat for your mobile app.Visit the iOS SDK documentation.Visit the Android SDK documentation.Visit the React Native SDK documentation
Powered by Kustomer