Skip to main content

Customers

Overview#

When we reference customers, we're talking about your customers. Your organization creates customers and integrations in Prismatic. Then, your customers can either enable instances of your integrations themselves through your integration marketplace, or your team members can deploy instances to them. You can create users for your customers and assign them roles so that they can manage and have insight into the instances that are deployed to them.

Like all Prismatic resources, customers can be managed via Prismatic's CLI tool, prism, or through the web app by clicking the Customers link on the left-hand sidebar.

Creating New Customers#

After clicking on the Customers link on the left-hand sidebar, click the + Customer button on the upper-right. Enter an appropriate name and description for your customer.

Searching Customers#

After clicking the Customers link on the left-hand sidebar, you can enter a portion of a customer's name into the search bar to filter customers by name. To filter customers by description instead, click the Filters button to the right of the search bar.

Modifying Customers#

After clicking the Customers link on the left-hand sidebar, you will be presented with a list of your customers.

Clicking the name of any customer will bring you to the customer's page. This page contains a menu with options to manage instances assigned to the customer, alert monitors, logs, credentials, customer users, and file attachments.

Editing Customer Name, Description and Logo#

From the customer's page click the customer's name on the top of the page to change the customer's name. To modify the longer description of the customer, click into the Summary tab. To modify the customer's avatar icon, click the customer's avatar on the top of the page next to the customer's name. The avatar icon you upload will be resized and cropped to 500 x 500 pixels. Transparent PNG images tend to look the best.

Deploying Instances to a Customer#

An instance of an integration is a versioned copy of an integration that is configured and deployed to a specific customer. Config variables and credentials that are unique to the customer can be applied to an instance.

For more information on attaching config variables and credentials, see the instances page.

From the customer's page select the Instances tab. There, you will see any instances currently deployed to your customer, with information on when they were last run, what versions are deployed, etc.

To deploy a new instance, click the + Instance button on the top-right corner. Select the integration you wish to deploy, and give the instance an appropriate name and description.

Once the instance is created, you will be prompted to configure any config variables and credentials required by the integration.

For More Information: Instances and Configuration-Driven Integration Quickstart

Managing Alert Monitors#

Alert monitors allow you to send alerts to your team when an alert trigger fires on an instance.

For example, you may want to your DevOps team to be alerted via text message when an instance fails to run, or you may want your project management team to be emailed when an instance is enabled.

From the customer's page select the Monitors tab. There, you will see any monitors currently deployed to your customer, with information on if/when it was last triggered, which instance it is associated with, and what triggers the monitor.

To deploy a new monitor, click the + Monitor button on the top-right corner. Give the monitor a name and select the instance to attach to, and trigger that will activate this alert.

After creating the new monitor, select the users to alert or webhooks to invoke when the monitor is triggered from the Summary tab. You can add additional triggers that will trigger an alert. When you are finished editing the alert, be sure to click Save to save your changes.

For More Information: Alert Monitors

Accessing Customer Logs#

At Prismatic we believe verbose and searchable logs are critical to any software ecosystem. Logs of all instance invocations are stored for all customers, and are searchable and filterable.

To access logs of instances for a specific customer, open the customer's page and select the Logs tab.

You can search log messages using the search bar on the top of the page.

Logs can be filtered by clicking the Filter button to the right of the search bar. You can filter logs by:

  • Log Severity (Error, Warn, Info, or Debug)
  • Date/time Range
  • Integration Name

Clicking on a log line will open a pane with the full message of the log.

For More Information: Logging, Log Retention, Logging from Custom Components

Viewing Instance Execution Results#

It's useful for debugging purposes to be able to see execution results of instance invocations. Click the Executions tab from a customer's page to see the logs and step outputs of all instances deployed to that customer.

Managing Customer Credentials#

Credentials store login information for the services your integrations interact with. For example, a customer might have Dropbox OAuth2 tokens or AWS access keys in their credential store.

From the customer's page select the Credentials tab. You will see a list of credentials that are saved for that customer.

To add new credentials for a customer, click the + Credential button. Enter the authorization method appropriate for your use case.

After selecting the authorization method, and clicking add you will be prompted to enter username, password, or API key values, etc., depending on the authorization method you chose. Be sure to click Save after editing a credential to save your changes.

Credentials can be deleted by clicking the credential from the credentials tab and clicking the Delete Credential button.

For More Information: Credentials

Managing Customer Users#

Customer users are users at your customer locations who have access to instances deployed to them. Depending on the role you assign to the user, the user might have read or write access to their instances. That means that you can grant permission to your customers to update instances that are deployed to them, so they can do things like update config variables or credentials to third-party APIs without needing you to intervene.

Customer users' accounts are limited in scope. They cannot view instances belonging to your other customers, nor see organization-level resources.

Users for your customers are managed by opening a customer's page and selecting the Users tab.

New users can be added by clicking the +User button. Enter the user's name and email address and give the user an appropriate role. More information about customer user roles can be found on the users page.

When users are added, they receive an email confirmation that will prompt them to log in and set their password and optional phone number.

To delete a user, select the user from the Users tab. Click the Delete Account on the bottom of the page.

For More Information: Users

Using Customer Attachments#

Attachments are a place to store documents that both customers and your team members can reference. After opening a customer's page select the Attachments tab.

Documents can be added using the +ADD ATTACHMENT button, and deleted by clicking the

icon.

Deleting Customers#

Deleting a Customer is Permanent

When a customer is deleted, all associated users, credentials, and instances are also deleted. Use caution when deleting customers.

After clicking on the Customers link on the left-hand sidebar, click the name of the customer you would like to delete, and then select the Summary tab.

Verify that the name shown matches the customer you wish to delete, and click the Delete Customer button. Confirm your choice by typing the customer name exactly, and then click REMOVE CUSTOMER.

Customer External IDs#

A customer can be assigned an External ID - a unique identifier from an external system. So, if you know "Smith Rocket Company" as a customer with an ID of abc-123 in another system you use, you can assign "Smith Rocket Company" in Prismatic the externalId of abc-123. This is helpful if you need to quickly look up or associate customers in Prismatic with customers in your external system.

External IDs can be set programmatically (see the next section), or can be edited within the Prismatic we app by clicking the Customers link on the left-hand sidebar, and then selecting a customer.

External IDs are required if you want to route webhook requests to instances deployed to specific customers using shared webhook triggers.

Sync Customers from an External System Programmatically#

If you use a customer management tool to keep track of your customers, like Salesforce or another tool specific to your company or industry, you can use Prismatic's API to programmatically sync customers from your external tool to Prismatic.

In addition at a name and description, a customer created through the createCustomer mutation can be assigned an externalId, so that you can match customers in Prismatic to customers saved in other systems.

See our Syncing Customers to Prismatic quickstart guide for an example of how to sync customers to Prismatic using our API.