You can install the Unbabel app in your Kustomer instance by finding it under the Apps directory.
Installing the app
Start by installing the app in Kustomer.
1 - Click on the Apps icon on the left navigation bar, then click Explore Directory.
2 - Search for the Unbabel app by typing its name in the search bar.
3 - Click the app to open a new window. Run and complete the installation.
Creating the Kustomer API tokens
You will need to create two tokens to integrate with Unbabel. These will be used to continue the setup of the integration remotely, and to communicate with Unbabel's API. We recommend that two tokens are created to enhance security. To do this:
4 - Go to Kustomer Settings > Security > API Keys and click + Add API Key
5 - A pop up window asking for details will appear
- To create the Unbabel Deployment API token use the following values
- Name: Unbabel Deployment API
- Roles: org.admin, org.admin.shortcut, org.admin.tag, org.admin.team, org.hooks
- Expiration days: 60
- Do not add IP restrictions
- Click Create
- To create the Unbabel Kustomer API token use the following values
- Name: Unbabel Kustomer API
- Roles: org.admin, org.user
- Expiration days: no expiration
- Do not add IP restrictions
- Click Create
6 - Copy the Unbabel Deployment API token and share it with the Unbabel Integrations Delivery team. The team will use it to run Gitlab pipelines and proceed with the configuration of Unbabel on your instance.
Note: If you have multiple deployment regions we will also need you to share the Canonical name of the instance where you have Unbabel for Kustomer installed.
Integration Delivery (IDM) runs GitLab process on Unbabel side
7 - The Integration Delivery team will continue the installation on the Unbabel side and get in touch with you once it is complete. Until then, please hold for confirmation.
Configuring workflows and team
Once the Unbabel team performs its configuration, you can resume and complete the setup on your instance.
Note: please don't try these steps before the Integration Delivery team asks you to.
8 - Head to Settings > Platform > Workflows to find the Unbabel workflows and activate all of them.
9 - Head to Settings > Users > Teams. Find the new “Unbabel Team” and add the users you wish to have access to Unbabel to the team. Save your changes.
Filling in the App settings
10 - The Unbabel app has setting fields that are required to be correctly filled for the integration to work. To access them, click Apps in the left navigation panel and select Unbabel under the apps directory.
The settings window will appear. Fill in all the existing fields.
See where to obtain the required information below:
-
Canonical name
- This value corresponds to the Kustomer instance's name
-
To obtain it: copy the first part of your instances URL before "kustomerapp"
Ex: https://[KUSTOMER_DOMAIN].kustomerapp.com/app/dashboard/performance
N.B.
- The Canonical name will need to be shared with the Unbabel Integration Delivery team.
-
From Email
- This is the organization-wide email address.
- To obtain it: Head to Apps -> Email -> Address and select the address you wish to use with Unbabel.
-
Status webhook
- This webhook is responsible for returning translation status updates on the Insight Card
-
To obtain it: Head to Settings > Platform > Inbound webhook. Search for the webhook under Form Hooks named Unbabel Async Translation Status Form Hook. Click the three dots icon and copy the hook address.
-
Installation ID
- Unbabel's installation ID. Represents your instance on the Unbabel apis
- To obtain it: Provided by the Integration Delivery team at Unbabel.
- You need to share the Translation Ingest webhook address with Unbabel to receive this ID. Head to Settings > Platform > Inbound webhook. Search for the webhook under Form Hooks named Unbabel Async Translation Ingest Form Hook. Click the three dots icon and copy the hook address.
-
Kustomer API token
- Kustomer's authorization token enabling Unbabel to access the instance
- To obtain it: this is the Unbabel Kustomer API token created in step 4 of the installation.
-
Unbabel Team ID
- The ID of the team of users authorized to use Unbabel
- To obtain it: Head to Settings > Users > Teams, click to edit the Unbabel Team and copy the ID from the url path.
-
Unbabel API token
- A secure token that allows the Kustomer Instance to access Unbabel
- To obtain it: the username and API key are found in the Integrations app in the Customer Portal.
- Format: username:api_key
Make sure to get the credentials from the Unbabel Portal and add them to Kustomer in the format username:api_key.
-
Unbabel User ID 1
- Primary Kustomer super user for Unbabel app
- To obtain it: Head to Settings > Users > Users, click to edit the Unbabel Team and copy the ID from the url path.
-
Unbabel User ID 2
- Secondary Kustomer super user for Unbabel app.
- Optional
- To obtain it: Head to Settings > Users > Users, click to edit the Unbabel Team and copy the ID from the url path.
Creating reply Email Template and update workflows
In order to be able to use the Unbabel App to its full intended functionality there is one last configuration needed: creating reply email templates and updating the respective workflows.
11 - Head to Settings > Administration > Email Templates and click Add Template.
12 - Name your template and create it as an Email Reply template type.
13 - Click to edit your new template and copy the ID in the URL as seen below.
14 - Head to Settings > Platform > Workflows and look for an existing workflow named UnbabelAsync - Assign Outbound Template, and click it to edit it.
15 - Find the Assign Default Template step in the workflow and click it. This will open the step properties. Scroll down to find "UBA - Outbound Template (string)" and paste the template ID you copied.
16 - Repeat this process for all language templates below this step.
17 - Save all changes.
The installation and configuration are now complete.