Connecting Pathlight to Kustomer

For Pathlight to integrate with Kustomer, we adopt the basic authentication (private app API Key) authentication to access the Kustomer API.

Each access token (or API key) is tied to a specific user and has the same permissions as the user that holds them. Requests made with an access token will act on behalf of a user and will have access to the resources their permissions allow. Kustomer account admin can easily generate and revoke access token via account settings.

Method: Basic Authentication

1. Navigate to your Company's Kustomer account and go to Settings and select Security > API Keys.  
2. Select Add API Key.
3. A popup will appear to edit your new API key. Start by giving the new API key a name. We suggest giving the name of Pathlight
4. Under Roles, include the 23 roles that are needed below:
   1. org.user.search.read
   2. org.user.setting.read
   3. org.admin.search.read
   4. org.permission.search.create
   5. org.permission.search.update
   6. org.permission.search_global.create
   7. org.permission.search_preview.create
   8. org.permission.setting.read
   9. org.permission.customer.read
   10. org.permission.message.read
   11. org.permission.conversation.read
   12. org.permission.team.read
   13. org.permission.user.read
   14. org.permission.kobject.read
   15. orb.permission.kobject.create
   16. org.user.tag.read
   17. org.admin.tag.read
   18. org.permission.tag.read
   19. org.user.content.shortcut.read
   20. org.user.shortcut.read
   21. org.admin.content.shortcut.read
   22. org.admin.shortcut.read
   23. org.permission.shortcut.read
5. In the Expires menu, select the number of days that the API key should remain valid before it expires. This should be set to Never
6. Select Create to finish creating the new key.
7. On the confirmation screen, you'll be shown your new key. For security reasons, this is your one and only chance to copy the key. Select Copy Token  to copy the hash to your clipboard and store it securely.
8. Securely share your username and API Key via secure email*.

Kustomer Authentication Reference

* If you do not have the means to share securely, we recommend using the Virtru email extension to securely email share this information.

__________________________________________________________________________________

We hope this was helpful! Please submit a ticket here if you have any questions or need further assistance.