The Customers tab is an essential tab within the Workato Embedded Admin Console that gives partners a detailed look into usage and statistics within customer accounts. Here, partners can view more details of each customer account, add/remove and manage customer accounts, and access them.
The following sections cover how to use the information provided in the customer tab to your best advantage.
# Customer table
The customer table displays the full list of customers and the following information for each customer:
- Displays the customer name, external ID (in brackets if present), and plan. You can change these values in the customer's Settings tab.
- The customer account was created on this date.
- Tasks used in billing period
- This is the number of tasks available to the customer each month. The plan type determines the task limit.
- The number of authenticated connections. The plan type determines the connection limit.
- Connected apps
- Icons of the top five apps connected to the account.
# Sorting, Searching, & Filtering
You can sort the preceding table headers, except for Connected apps. Sorting is enabled by clicking on the table headers. Clicking twice reverses the sorting order.
- Sorts customer name alphabetically.
- Sorts records by date joined.
- Sorts records by the number of tasks consumed.
- Sorts records by the number of authenticated connections.
Use the search bar and tabs to search and filter by the following:
- Search by customer name or external ID. Searched terms are highlighted in the results.
- Filter by plans available. This list of plans corresponds to your list of custom plans. To add or remove plans, contact your Customer Success Representative.
- A customer's status can be Active, Expired subscription, or In trial. Customers with an Expired subscription are enrolled in a Workato Community (free) plan. This plan has a limit of 100 tasks/month and reflects a trial expiration or plan downgrade. Remove customers when their subscription ends.
- Use this filter to view specific customers using a selected app.
- Date joined
- Filter customers by date joined. Select an available date range or provide a custom date range.
# Adding a customer
There are two ways to add customers:
- Directly in the user interface
- Using a Workato Embedded platform API
To add a customer in the Workato app, click the + Add customer button. Enter the following information for the customer:
- Customer name
- Notification email (This email receives recipe errors.)
- External ID (optional)
Adding a customer in the app
# Customer information
Individual customer information pages are available when you click a customer in the table. This page lets admins view the customer's dashboard and customer team members. You can also change account settings.
# Customer dashboard
The dashboard displays the number of active recipes running and the success/error rates across the recipes. You can filter the recipes by time period.
Customer information page
The Collaborators tab displays the team members in the account, including their names, emails, and roles. A unique tag identifies Customer managers.
Customer team collaborators
# Switching to customer accounts
Customer managers can access a customer's account by clicking the Switch to this account button on the top right of the page.
If additional team members require access to the account, you can manually add them to the team while in the customer account.
The Settings tab controls the configuration for the customer's account, including:
- Plan details
- App access
- External ID
iframeorigin URL (for Workato Embedded/Embedded connection widget only)
- Account deletion
Updating customer name
To update a customer's name, navigate to the Customer's account to edit the workspace name. Learn more about how to update a customer account name.
# Plan details
To change a customer account's plan or trial status, use the Subscription option in the Customer > Settings tab. You can change plans to an existing custom plan.
To add or remove plans, contact your customer success manager.
The Trial option lets you put the customer's account in a trial status, enabling the customer to try the Workato platform for 30 days. Accounts in a trial status have a limit of 100 tasks per month.
After the 30-day trial period ends, Workato automatically downgrades the plan to the Free plan. As a Workato Embedded partner, you can extend the trial by re-enabling it and changing the customer's plan.
After the customer subscribes, disable the Trial option. This places the customer in an active subscription.
# App access
When you create a customer account, the account can access all available apps by default. You can select the apps a customer account can access in the App access tab. you can select the apps a customer account can access.
When apps are selected, the customer account can only discover and connect to the selected apps. This also applies to apps in the Community Library.
Follow these steps to modify the list of available apps for a customer:
Open the customer's Settings > App access tab in your partner account.
Click the Edit button in the App access tab.
In the window that displays, select the app(s) you want the customer to access. To remove access to an app, de-select it.
When finished, click Apply changes.
After selecting apps, you must manually add new apps to the accessible apps list to grant the customer access..
# External ID
The external ID is a customer ID assigned to the customer by the Workato Embedded partner. This ID usually corresponds to a customer ID within your CRM. You can change the value anytime, but doing so affects any APIs using the external ID as an input.
Additionally, Workato assigns each customer a unique User ID. This ID appears in the URL of the Customer Information page:
In this example, the User ID is
iframe origin URL
The iframe origin URL setting is available only for customers using Workato embedded.
Entering a URL into the
iframe origin URL field overrides the value set in the Partner admin account.
Suppose a partner account has an origin URL of
https://company.com. If you don't set an origin URL in the customer account, the customer account inherits the origin from the partner account.
If the customer has a unique domain they log in with, for example,
https://customer.company.com, you can use the iframe origin URL setting to define and apply this only to that specific customer.
If your application supports multiple custom domains or workspaces, this setting enables those features.
# Multiple origins per customer
In addition to setting customer-specific origin URLs, you can define multiple origins per customer.
In the iframe origin URL field, enter a list of URLs separated by commas. For example:
When defined, the origins should be provided as
origin after generating the JWT. After the user signs in using the JWT, the provided origin is saved into the session object and used for the session's lifetime until the user signs out. For more info about JWT direct linking, refer to this guide.
# Delete account
The Workato Embedded partner may delete a customer account at any time. Deleting a customer account is permanent and removes all data and recipes associated with the account. You cannot recover deleted accounts.
# Update customer name
To update a customer name, you must first switch to the customer account.
Only customer managers with Collaborator privileges are allowed to update the customer name.
Select the customer account to update from the Customer table > Click on Switch to this account located on the top right.
Switch to customer account button
Once inside the customer account, navigate to Workspace access on the left side toolbar.
In the Settings tab, you will be able to update the Team name.
Settings - Update customer name
# Customer management APIs
Customer management APIs perform a variety of functions on a customer account. View the list of Customer management APIs here.
Last updated: 8/7/2023, 7:58:28 PM