Cookie consent

By clicking “Accept”, you agree to the storing of cookies on your device to enhance site navigation, analyze site usage, and assist in our marketing efforts. View our Privacy Policy for more information.

Create an integration

The Custom Integration framework enables you to create flexible integrations with third party services. Using integrations you can build in automation to your Cutover runbooks for increased visibility, control and efficiency. 

Custom integrations handle a variety of HTTP request methods that conform to API standards, capture and store response data within Cutover, handle authentication, and poll API endpoints for certain conditions. Advanced features allow customization of request payloads, definition of variable endpoints, and inspection of nested API responses to retrieve the values you need. 

Note: The Custom integration has been created for users with a basic understanding of RESTful APIs and knowledge of Cutover custom fields.

Follow our step-by-step guide to find out how to set up your own Custom integration. You can also click here to see our example integrations using the Cutover integration suite.

Getting started 

In order to build your integrations through the Cutover Integration suite, you will need the following roles:

  • Integrations admin role - An Integrations Admin can view, create, and manage integrations and task types within the Global Settings of a Cutover instance.
  • Custom fields admin - A Custom Fields Admin can access Custom Fields and Custom Field Groups within the Global Settings of a Cutover instance, with read and create permissions only.

Steps for creating a custom integration

In order to create a Custom integration, you will need to follow the steps listed below - each step will be explained in more detail within the Custom Integration sections: 

  1. Set up your integration connection 
  2. Add in an integration action 
  3. Add in your integration settings in the General tab
  4. Create any Custom Fields. Custom Fields can be used to capture additional information at a task and runbook level. For further information, click here to visit our Help Center. 
  5. Include the authorization type to be used by the integration requests in the Authorization tab
  6. Add in your request properties in the Request tab
  7. Fill in any polling settings in the Polling tab - (if you are using polling)

Create a custom integration connection

Once the prerequisites are met, you can create your custom integration in Cutover by following these steps: 

1. Click Settings (the cog icon at the bottom of the sidebar), then click Integrations.
2. Any previously configured custom integrations will be displayed on the Integrations Connections page. 

3. To find out how to set up a custom integration or see step by step guides for some of our most requested integrations, click on Learn more at the top of the Integrations Connections page

4. If you’re ready to build your integration, click Create Integration.

5. The New Integration Connection modal is shown. You can choose from two types of integration: 

Custom integration: This type of integration gives you the flexibility to create integrations based on your requirements via any authorization. 

Predefined integration: This type of integration has been set up with predefined fields and default authorization.

To find out more about the types of integration, click the appropriate radio button and then click the Learn more button inside the New Integration Connection modal window.  

6. If you select the Predefined Integration radio option, select an integration from the Integration dropdown list. The information required will change depending on the integration chosen. Enter any mandatory fields and click Create

The newly created integration will be listed at the bottom of the Integrations Connections page. 

Note: As this content is based on our Custom Integration, please see our Help Center for further information on setting up any predefined integrations.

7. If you select the Custom Integration radio option, you will need to enter a name and (optionally) an image URL for your integration (if this is left blank, a default image URL will be displayed). Click Create.

The newly created integration will be listed at the bottom of the Integrations Connections page.

Add an integration action 

Within an integration connection, you are able to build multiple integration actions. Select your newly added Custom Integration from the Integrations Connections list to open the Edit panel. Next to Integration Actions, click New.  

A new modal window will appear where you can select and complete details for your integration action. Further information about integration actions and how to complete these can be found in each of the Settings tabs. 

Note: When a new integration action is created, it will display underneath the Integration Actions section. In the screenshot below, you can see we have built a Jira integration connection followed by two integration actions. 

Edit an existing integration and action

To edit an existing integration connection, click on the integration you would like to edit. The integration name, image URL, and any other fields can be edited as needed. In addition to editing the integration details, you can edit any action within the integration itself by clicking the small cog icon next to the trigger details: 

Clicking the cog will reveal an edit form for the integration action where all default and custom settings already entered are stored, as seen via the image below:

After creating your integration action, you can build your integration. Within the integration action builder there are the following tabs: 

Please see these sections for further information on setting up your Custom integration.