What are Deployments?

A deployment is a collection of templates. It may contain one or more templates. Deployments can be created to facilitate different requirements that you or your users may have.

Facilitating your users

Deployments allow you to manage your templates and show only the relevant ones to your users. The SDK embedded inside your app or hosted by Integry always shows the templates (integrations) that are inside one deployment to the user. You cannot independently embed a single template inside the SDK, you have to add it to a deployment. You can always add more templates later to a deployment, without any additional work.

Using deployments, you can segment the integrations for your users. Suppose you have integrated your app with HR apps, task managers, and marketing automation apps. The group of users who manage their HR tasks and activities from inside your app might not want to see or be a part of drip campaigns integrations. So, you can create different deployments to incorporate the requirements of different categories of users.

Another common practice is to segment your customers based on your pricing tiers. Create a deployment for each pricing tier, add respective templates to each deployment based on what you want to offer, and incentivize your customers to upgrade their accounts to avail more powerful integrations.

Facilitating you

There are two different types of deployments that you can create:

  1. SDK Deployment
  2. Directory Deployment

With these types, you can choose between embedding the integrations inside your app, or letting Integry host them for you.

You can either create an SDK deployment and get that embedded inside your app. Or if you prefer a quicker method of delivering integrations to your users, you can create a Directory deployment, which is basically your own App Directory that is hosted by Integry for your users. With a Directory deployment, you can avoid the SDK embedding step in the integrations rollout. This will take away the native integrations element, but your integrations will become up and running for your users faster, with less effort. You can also avail both versions of app listings: App Directory and in-app SDK as well.

Each deployment is identified by its ID referred to as a Bundle ID. Once a deployment is used by a user, Integry creates an instance of it called a Bundle Instance and it also has an ID.

The deployments inside your app can be viewed under the Deployments tab in your dashboard as shown below.

A few details about Deployment cards as seen above are highlighted and explained below.

  1. Your app's icon: The favicon of your deployment. This is usually the logo of the host app for integrations.
  2. Deployment type: This shows whether your deployment is an App Directory or an SDK to be embedded. Both have different icons.
  3. Number of Templates: This is the count of templates inside the deployment.
  4. Number of Users: The count of unique users using this deployment.
  5. Number of Installs: The number of integrations set up using this deployment.
  6. Status of your deployment: If your deployment is saved and approved by us, it will be published for your users and you will see the LIVE tag with it.

If you have multiple apps, you can select the app you want to work on from the workspace drop-down on the top right corner of the dashboard. This drop-down lists all of your apps. You only see the deployments from the app selected. When you create a new deployment, it is also created in this app. This app selection persists between Templates and Deployments tabs.

When you click on a deployment on the Deployments page, you are directed to the deployment configuration page. This configuration page and settings vary based on the type of your deployment. On the basic info page of both the types, you can update the deployment details or add template or app cards as shown below. 

The rest of the configuration details are discussed here for a Directory Deployment, and here for the SDK Deployment. You can create your own deployment by following the respective guide.

Did this answer your question?