Instances

Overview

An instance of an integration is a copy of a versioned integration that has been created for a customer. When the instance is created for a customer, config variables and credentials specific to that customer are be set. The combination of the instance and assigned config variables and credentials is referred to as a deployed instance.

Creating Instances

When you are satisfied with an integration and have published a version of it, you can create an instance of that integration for a customer.

Start by clicking the Customers link on the left-hand sidebar, and then select a customer. From the customer's page open the Instances tab. There, you will see any instances currently deployed to your customer, with information about when the instances were last run, what versions are deployed, etc.

To create a new instance, click the + Instance button on the top-right corner. Select the integration you wish to create an instance for, 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: Versioning Integrations

Setting Instance Config Variables

Instances may require config variables to operate. Those config variables may vary between customers, so config variables are set when an instance is deployed (as opposed to when an integration is published).

After creating a new instance or clicking into an existing instance, you will find yourself in the instance's Status tab. Here, you will find information about the instance's webhook URL (if it uses a webhook trigger), its deployed and enabled state, and config variables and credentials that are associated with the instance.

If the integration you created this instance from requires configuration variables, you will be given the opportunity to set configuration variable values under the Instance Config Variables tab. Click the drop-down menu for each required config variable and select a config variable value for this instance. You will be presented with a list of config variables that are set at the organization level, or at the customer level for the current customer. If you want to add an organization or customer config variable at this point, you can click the + Customer Variable or + Organization Variable buttons.

For More Information: Configuration Variables, Config Vars and Credentials Quickstart

Setting Instance Credentials

Like config variables, credentials are may vary between customers, and so are set after an instance is created.

Within an instance's status tab, you will find the Credentials card beneath the Instance Config Variables card. You can associate credentials with a step using the provided drop-down menus.

Not all steps need credentials

It is not necessary to fill in all drop-downs. Some actions, like AWS S3 or Dropbox actions require credentials, but for other actions credentials are optional or not applicable.

For More Information: Authorization Credentials, Config Vars and Credentials Quickstart

Deploying an Instance

A deployment of an instance is a combination of the instance and the config variables and credentials associated with the instance. After setting config variables and credentials, click the DEPLOY button in the upper-right of the instance Status tab.

Why aren't instances deployed automatically when they are created?

Before instance can run, they need to be configured with instance-specific config variables and credentials. Once they are configured, they can be deployed.

Why didn't changes to my instance's config vars and credentials take effect after modifying them?

Changes to config variables and credentials do not take effect until you click DEPLOY. This is done because the credentials and config variables may depend on one another, and need to be updated simultaneously. For example, you may choose to change the AWS account and S3 bucket you wish an instance to write files to. You will want to edit both the S3 bucket name as a config variable, and credentials tied to the S3 action step before either of those changes take effect.

Enabling and Disabling Instances

If you would like to stop a deployed instance from executing, click the icon in the upper-right of the instance Status tab to disable the instance. When disabled, your instance will not execute on a cron schedule (if configured to use scheduled triggers), nor respond to webhook invocations.

To re-enable a disabled instance, click the icon.

Invoking a Test of an Instance

You can invoke an instance outside of its cron schedule to ensure it functions properly. To force an enabled instance to run, click the RUN TEST button from the instance's Status tab, or run prism instances:test ${INSTANCE_ID} from the command line.

Logs from the test can be found by clicking the Logs tab.

Adding Alert Monitors to Instances

Instance alert monitors allow you to notify your team when a variety of things occur, including failed instance executions, slow executions, instances in unexpected disabled states, etc. They can be found by clicking the Monitors tab from the instance's page.

For more information: Creating Alert Monitors.

Viewing Instance Logs

Logs for an instance can be viewed by clicking the Logs tab from the instance's page.

You can search log message text through the Search Logs search bar on the top of the page, and you can filter logs by Log Severity or date range by clicking the Filter link to the right of the search bar.

For More Information: Logging

Deleting an Instance

Deleting an instance removes the instance and any associated data. Before choosing to delete an instance, consider if you want to disable the instance from running instead.

If you choose to delete the instance, scroll to the bottom of the instance's Status tab. Click the Delete Instance button, and type the name of the instance in the input field to confirm that you want to delete the instance. Click REMOVE INSTANCE.

Searching Instances Across Customers

Click the Instances link on the left-hand sidebar to view all instances for all customers. You can search instance names through the Search Instances search bar on the top of the page. You can further filter instances by description or integration by clicking the Filter link to the right of the search bar.

How do I filter instances by customer?

To view instances for a specific customer, click the Customers link on the left-hand sidebar and select a customer. Select the Instances tab to view instances for that customer.

Last updated on