A deployment is a collection of one or more templates. Deployments facilitate different requirements that you or your users may have.

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. More details on the concept and benefits of deployments can be found here.

When you create a template, you are required to add it to deployment. So when you press the Continue button on the New Template Page, you are directed to Add to a Deployment Page. You can add your template to an existing deployment or create a new one. 

Let's see how you can create a new deployment separately from your app dashboard.

Creating an SDK deployment

To create a deployment, go to the Deployments section in your dashboard. You will be able to see all the previously saved deployments here as shown below.

Click on Create a Deployment. You will then be asked to select a deployment type as shown below.

There are two types of deployments. First is the embedded SDK deployment, which is basically the deployment of integrations on an SDK that will be embedded inside your app. The second is the Directory deployment, that publishes your integrations in an App Directory on a subdomain that you provide. The procedure for creating a Directory deployment is mentioned in detail here. Here, we'll talk about the method for creating the SDK deployment.

Clicking on the SDK option in the above image will take you to the deployment info page as shown below.

After providing a name for your deployment, you will need to select the Cards that you want to show to your users on the integrations listing page. The available cards on the right side in the above image will consist of all your templates and the external apps that you’ve created. Your chosen cards will be added to the Selected Cards box on the left.

The selected cards shown above will appear to your users as available integrations in the SDK embedded inside your app.

Embed Code

After you have added the templates and external apps to your deployment, you can scroll down to see an Embed code as shown below.

To add this deployment inside your app, you will need to embed this JavaScript code snippet inside your app’s HTML. It fetches the list of templates and apps present in this deployment from Integry and displays it inside your app, making them ready for integrations for your users.

This snippet uses the App key to authorize itself with Integry on behalf of your app. We have a detailed guide on how to embed this code snippet in your app.

Once you have set up this basic info page for the deployment, you can just click on the Create Embed button at the bottom right to create and save this deployment. This will then be added to the Deployments menu in your app dashboard. You can always open an SDK deployment from here to check and copy the Embed code, or add or delete the templates from the deployment.

Happy Integrating!

Did this answer your question?