Step 4: Deploying Your Integration to Customers

What you will accomplish

In this tutorial you will deploy the integration you created to a customer that you created.

Create and deploy an instance to a customer

Web App

Click the Customers link on the left-hand sidebar and click + Instance on the customer you would like to deploy to.

Select the integration you created from the drop-down, and give the instance a name and description of your choice.

Once your instance has been created, you will be brought to the instance's Configuration screen.

On the bottom of this page, you can customize Slack Webhook URL and Todo API URL for this customer (or leave the defaults). Once you are satisfied with the configuration, click the SAVE AND DEPLOY button on the top of the page.

You can now test the instance by clicking into the Test tab and clicking RUN TEST. You should get a Slack message, as you did before.

CLI

To create an instance for a customer, you will need to know the ID of the integration, and the ID of the customer. Pass those two IDs in as input to the prism instances:create command.

# Get your integration IDprism integrations:list --extended
 Id                                                               Name                 Description                                    Version ──────────────────────────────────────────────────────────────── ──────────────────── ────────────────────────────────────────────── ─────── SW50ZWdyYXRpb246YTAyNTdhYjAtZTMwZC00MGMwLWJjZmEtMDZhYTM3Yzg1OWYz My First Integration  Pulling from a REST API, and pushing to Slack 1
# Get your customer's IDprism customers:list --extended
 Id                                                           Name        Description ──────────────────────────────────────────────────────────── ─────────── ──────────────────────────── Q3VzdG9tZXI6ZjE2MDg5ZGItMDZmNC00ZGE0LTlhY2MtZDEzNmRhYjA2ZGYw FTL Rockets Faster-Than-Light Rocket Inc
# Publish your integrationprism instances:create \    --integration SW50ZWdyYXRpb246YTAyNTdhYjAtZTMwZC00MGMwLWJjZmEtMDZhYTM3Yzg1OWYz \    --customer Q3VzdG9tZXI6ZjE2MDg5ZGItMDZmNC00ZGE0LTlhY2MtZDEzNmRhYjA2ZGYw \    --name 'My First Instance' \    --description 'Deployment of "My First Integration" to "FTL Rockets"'SW5zdGFuY2U6ODEyMjNiZTEtODA2ZC00ZjE5LTkzMTItOWU0MDU3ZTc5YmY3

The value returned from the instances:create command is the ID of the instance.

Finally, we will "deploy" the instance (marking it active) through prism instances:deploy, and then test the instance with prism instances:test to verify it works as expected and you get a Slack message.

# Deploy the instanceprism instances:deploy SW5zdGFuY2U6ODEyMjNiZTEtODA2ZC00ZjE5LTkzMTItOWU0MDU3ZTc5YmY3prism instances:flow-configs:list --extended SW5zdGFuY2U6ODEyMjNiZTEtODA2ZC00ZjE5LTkzMTItOWU0MDU3ZTc5YmY3prism instances:flow-configs:test SW5zdGFuY2U6ODExampleExampleExampleExampleExample

Next steps

The integration you created is now live and active at a customer. You can deploy it to your second customer if you wish.

In the final getting started tutorial, you will add monitoring and alerting to your instances, so you know if something goes wrong.