Set up your portal

Learn how to set up a secure portal for your customers.
  • Set up your portal

    Organizations can create a branded portal where your customers can log in to view and respond to all conversations they’ve had with your support team. The portal also provides a secure location for internal users to view both internal and public facing knowledge base articles. Note: Organizations that have an existing custom knowledge base need to modify their theme in order for the portal to display properly. To do so, please follow these instructions and Upgrade your theme to version 1.0.20. If you created your theme using a Midtown template and did not customize it, you do not need to upgrade. By default, the portal is turned off for your organization. Once this setting is turned on, the Login link customers and internal users use to access the portal is available on your knowledge base home page. Who can access this feature?User typesUsers with Content Manager permissions and higher can set up the portal. Agents who are both full-time and collaborator can view articles in the portal.In this articlePortal for end customersSet up end user authenticationAllow customers to reopen conversationsAdd attribute to the Conversation Details viewPortal for agents and adminsCustomize the portal's themePortal for end customersThe portal provides a way for your customers to log in to a secure location and see their conversation history with your organization. To turn the portal on for end customers, go to Settings> Knowledge Base > Configuration. Select the Portal tab and then the Turn on My Conversations toggle. Once logged in, customers will see all of their open and closed conversations on the My Conversations page. The portal shows conversation history for the following channels:ChatEmailFacebook MessengerFormsInstagram (Direct Mentions only)PortalSMSTwitter (Direct Mentions only)WhatsAppCustomers can select a conversation from the list to view all of the messages within it. If the conversation's status is open, they can send a message from directly within the portal. Messages sent through the portal are limited to 10,240 characters. Customers can attach a maximum of 6 files to their message. Each file has a maximum size limit of 3MB. Supported file types are XSLX, CSV, DOC, DOCX, XML, PDF, GIF JPG, and PNG.Notes:Conversations are shown in the portal as they appear in the Kustomer timeline. This includes any modifications an agent may make to the conversation subject, as well as redacted information. Internal notes are not visible to a customer when viewing a conversation in the portal.You can turn off the customer's ability to reopen a previously closed conversation using the available setting.Messages sent through this view are sent through the Portal channeland will appear in the customer's timeline where an agent can respond. Customers receive the agent's response via email and can view the message in the portal by reloading the conversation page.Set up customer authenticationThe portal is a secure location where customers can access their conversation history with your organization. Select Portal Authentication to set up authentication for customers logging in to your portal.The following options are available:Kustomer Session Lifetime is the length of time (hours/days) that your users will stay authenticated within Kustomer before they are prompted to log in again. The default value is 1 day. The minimum length of time a customer can stay authenticated is 1 hour.Custom Sign On allows users to use your site's login process to sign in to the portal. For instructions on how to use this method, see Set up custom sign on for your portal.Allow customers to reopen conversationsThe portal is where customers can access their entire conversation history with your organization. By default, customers can reopen a previously closed conversation from directly within the portal and send a new message. Any message sent after a conversation is reopened will go through the Portal channel, and not the original channel that was used such as, chat or SMS. If you don't want customers to have the ability to reopen a conversation, turn off the Reopen Conversation toggle.Add attributes to the Conversation Details viewBy default, customers viewing a conversation in the portal can always see the conversation's status, channel, and created date. You can add additional attributes to the conversation details a customer sees by selecting them from the Add Attribute drop-down menu. When adding an attribute, you have the option of entering a display name either manually or by selecting a snippetfrom the available list.Portal for agents and adminsYour agents and admins can view both internal and public articles behind a secure portal log in. To turn the portal on for internal users, go to Settings> Knowledge Base > Configuration. Select the Portal tab and go to the Internal (Agents and Admin) section. Then, select the Turn on for Agents and Admins toggle. Next, make sure the internal KB is turned on for your org as this is how your users will access article articles in the portal. You can turn this on by going to the Configuration tab and selecting the Internal KB toggle.Once turned on, authenticated internal users can view an article in the portal from directly within Kustomer by going to the Knowledge Base fly out and selecting Open in a new window.Notes: Internal users access the portal using the same authentication settings they use to access the Kustomer app.Agents who are both full-time and collaborator can view articles in the portal.By default, turning on this feature gives access to view both public and internal articles in the portal. You can change this by selecting the Show only internal articles toggle.Customize the portal's themeYou can customize the portal's look to match your organization's personal branding using our theme editor.Go to Settings> Knowledge Base > Theme. Here, you can:Create a new theme using the Midtown template.Select your existing, unmodified theme that was created using a Midtown template. Select your existing custom theme and follow these instructions to Upgrade your theme to version 1.0.20 and get the portal features. You can confirm if you need to upgrade your theme by hovering ver the Custom Theme label. If you are on a version that requires these updates, you will see the base version you are on.Select My Conversations or Conversation Detail View from the drop-down menu.Once you are done modifying your view, select Save and Publish.
  • Set up custom sign on for your portal

    The portal allows customers to log in to an authenticated page and view their conversation history. With this flow, users are redirected from the portal through your site’s login process before returning to the portal, where new users are created and returning users are automatically logged in.This article outlines the steps you need to follow to set up custom authentication using your own login flow.Who can access this feature?User typesContent administrators can access knowledge base settings.In this article:Get secretImplement JWT signing with your secretRedirect users to Kustomer with the signed JWT tokenTurn on custom sign on for your portalGet secretThe first step is to obtain the secret needed to implement the JWT signing.In the Kustomer app, go to Settings> Knowledge Base > Configuration.Select the brand for which you are creating the portal from the Brand drop-down menu (if applicable). If you don’t have additional brands created, this will be the default brand.Scroll down to the Additional Information section in the General tab and copy your Knowledge Base ID.Make an API GET call to https://org-name.api.kustomerapp.com/v1/auth/kb/:id/settings, where org-name is the name of your Kustomer organization and:id is the ID of the knowledge base that you copied.If you do not know your organization name:If you are located in the Americas, use https://api.kustomerapp.com/v1/auth/kb/:id/settingsIf you are located in Europe, use https://api.prod2.kustomerapp.com/v1/auth/kb/:id/settingsYou will need a Bearer Authorization token to make this request. If you don't already have a token, you can create one by going to Settings> Security > API Keys. Select Add API Key and create a new key that does not expire using the org.admin role.Note: This API call returns a JSON payload containing a secret value inside the attributes field. Save this secret value in your server for reference later.Implement JWT signing with secretA user going through this login flow will be redirected from the Kustomer app to your domain:The login URL we redirect to will include an unsigned trackingToken parameter (which can be ignored) and a kustomerRedirectUri parameter which you’ll use to return the user to the Knowledge Base Portal.The URL we send authenticated users to will look like this: https://{yourLoginPage}?trackingToken=UNSIGNED_JWT_TOKEN&kustomerRedirectUri={urlBackToKustomerKnowledgeBasePortal}After a user has been successfully authenticated via email and password (or another method) against your servers:Sign a JWT token in your server using the secret value stored in step 4 of the Get secret procedure and the user’s email. The following is a sample of signing the token in nodeJS server code:var jwt = require('jsonwebtoken'); var token = jwt.sign({ email: "CUSTOMER_EMAIL", iat: Math.floor(Date.now() / 1000) }, 'SECRET_KEY', { header: { alg: 'HS256', typ: 'JWT' } }),When redirecting the user back to your Knowledge Base portal login page, pass the signed token set as an externalTokenquery parameter. Note: iat: Math.floor(Date.now() / 1000) is the current time in UTC seconds. Signed tokens will only be valid for 15 minutes.Redirect to Kustomer with the signed JWT tokenOnce authentication is finished in your site, redirect the user back to our website with the signed auth token.Redirect the user back to the kustomerRedirectUri query parameter that is passed to your login URL, which may look similar to: kustomerRedirectUri=https://yourcompanyname.kustomer.help/login?referralUrl=https://yourcompanyname.kustomer.helpInclude the signed JWT token on a new externalToken parameter. The URL you redirect to should be formatted as {kustomerRedirectUri}&externalToken={SIGNED_JWT_TOKEN} and look similar to:  https://orgname.kustomer.help/login?referralUrl=https%3A%2F%2Forgname.kustomer.help[...]&externalToken=eyJh[...]kQTurn on custom sign on for your portalThe final step is to turn on custom sign on and enter the URL of your portal log in page. This is the URL customers are redirected to once they click the Login in button on your portal. To turn on custom sign on:Go to Settings> Knowledge Base > Configuration.Select the Portal tab and then select Portal Authentication.Turn on the Custom Sign On toggle.Enter your unique log in page URL in the Redirect URI box.Select Done.Your customers can now sign in to your secure portal using your own login flow.
Powered by Kustomer