Skip to main content

Customer-Activated Connections

A Customer-Activated Connection is used when each of your customers have unique credentials to a third-party app, and they need to enter the credentials (or go through an OAuth 2.0 auth code flow) themselves. Your customer will enter usernames/passwords/API keys/etc for the third-party app when they deploy an instance of an integration that uses them.

Creating a new customer-activated connection​

To create a new customer-activated connection, open your organization's settings page by clicking your organization's name on the bottom-left, and then open the Connections tab.

  • Select + Add Connection.
  • Select a connector and connection type
  • Under Connection Type select Customer-Activated Connection
  • Give your customer-activated connection a recognizable name and description.
  • If the connector supports more than one connection type (like OAuth 2.0 and Personal API Key), select the connection type you'd like to use.
  • If you have more than one Prismatic tenant (e.g. US and EU tenants, or dev and prod tenants), update the default Stable Key to the same value in each tenant. That key will be used to match up customer-activated connections across your tenants.
Create a new customer-activated connection
  • Fill in all connection inputs and then click Next.
  • You'll have the option to provide test credentials, which can be used in the test runner as you build an integration that uses this connection.

Using an customer-activated connection in an integration​

The next time you add a connection to an integration, if you have an customer-activated connection defined for that connection type your integration designer will automatically reference it.

Customer-activated connection in the config wizard designer

When running a test execution within the integration designer, the test connection that you set previously will be used (or you can set one up within your integration).

If you deploy this integration to a customer, the customer will be prompted for their unique credentials to the third-party app.

FAQ​

What will customer users see?​

When your customer walks through an integration's configuration wizard that you've designed, they will be prompted to fill in their credentials to the third-party app.

Can customer-activated connections be used if I have multiple tenants?​

Yes. If your organization has multiple tenants (for example, a US and EU tenant, or a dev and prod tenant), be sure to assign your customer-activated connections the same Stable Key in each tenant. Then, when you sync integrations between tenants, your integrations will automatically use the correct customer-activated connection in the new tenant.