Custom Integration

Easily connect Cutover with any third-party application using our Custom Integration.

Cutover Documentation Team avatar
Written by Cutover Documentation Team
Updated over a week ago

We’ve enhanced our Integrations User Interface (UI) to offer an easier and user-friendly way to add, manage, and edit integrations in Cutover within the Global Settings > Integrations menu. We have also added the ability to build flexible integrations with third-party services.

Note: Please also see our Developer Portal's Custom Integration technical guide when adding and editing actions for a custom integration.

Role types

The following role types offer the ability to create and edit integrations.

Custom Field Admin

This role allows customers the ability to create new Custom Fields.

Integrations Admin

This role allows customers the ability to create, edit and archive all Cutover Integrations. This gives you the power to connect Cutover to any tool of your choice.

Note: Please contact your Cutover Customer Success team for more information about these role types.

Add a Custom Integration

To add a Custom Integration, navigate to Settings > Integrations.

Next, you will see a list of integrations currently enabled in your Cutover instance.

Note: If you have not previously added integrations, this page will be blank.

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 .

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

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.

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

Select your newly added Custom Integration to open the Edit Custom Integration panel. Next to Integration Actions, click New.

Next, a new modal window will appear where you can select and complete details for your integration action.

Note: Please see our Developer Portal's Custom Integration technical guide for further information on what should be entered into all of the tabs within this modal window.

When a new action item is created, it will display underneath the Integration Actions section as displayed in the image below:

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:

You can enable and disable the following settings under Additional Settings by ticking or unticking them:

  • Auto start: The task will automatically start upon the task's predecessor completing, without requiring manual intervention to get it underway. If the trigger is “On Task Start“ then this also means that the integration will fire automatically.

  • Enable fixed start time: It will be possible to add a fixed start time in a runbook’s editing panel for the task; this means the task can only be started at the day and time that has been set.

  • Cancelable: It will be possible to cancel a task during its execution.

  • Notify Webhook on Cancel: On task cancellation, an HTTP request will send an abort/cancel message to the specified URL.

Important: Aborting an integration prevents any further integration actions from being executed but will not stop any process that the integration has initiated when invoking the third-party API.

  • Finish task on success: The task will finish when the integration’s status is set to success.

  • Include context in Request: The outbound payload request will contain information about the runbook and task.

  • Execute in Rehearsal: The task can be executed when the runbook is in rehearsal mode.

When you have finished editing, you can click save or choose discard to abandon any changes that have been made.

Use your integration

Once the integration is configured, save the task. Next, head over to your runbook and add a new task. In the Task Type field, search for your integration connection and select it. When you select the integration, it will appear as a task in your runbook.

Now start your runbook. When the integration task is started, the integration is executed. The status of the integration will be displayed alongside with the task.

The status is once more updated when the integration is successful.

The integration is now completed and has executed its job within the context of the runbook.

If the status displays as Connection failed (with a reason displayed), you can refire the integration by clicking on the three vertical dots and choosing Refire Integration.

Any other integrations further ahead in your runbook will be executed once their task is started, giving you the power of automation and human and machine collaboration.

Debug an integration task

An Actions log is available for customers to view the progress and further information of an integration task. Click on the integration task in the runbook and the Task Details panel opens. To see a log of all the actions, scroll down to Actions.

If the integration has failed, customers can use the Actions log to debug and understand what the failure might have been.

Within the Actions section, click the Debug link to see the Request and Response screens of the integration. If there is an error with the request, a red warning triangle will display next to the tab name. If there is an error with the response, a red warning triangle will display next to the tab name.

Customers will need to go back to the settings area of their integration action and make changes to the editable fields within this section. Once this has been checked and updated, customers can run the integration again.

Note: Please see our Developer Portal's Custom Integration technical guide for further information on the Response and Request fields.

Did this answer your question?