Home Paris DevOps DevOps DevOps User-created DevOps integrations

User-created DevOps integrations

User-created integrations are for integrating additional planning, coding, and test tools not included in the integrations provided with the DevOps application.

The DevOps application includes tool definitions for integrating some common planning, coding, and test tools, but you can also set up user-created integrations for additional tools in your DevOps environment.

Note: User-created integrations for orchestration tools is not supported.

DevOps integration objects

DevOps tool integration consists of these objects.

Tool capability actions

Starting with version 1.9, Connect action:
When connecting, the subflow for the specific tool is called and the connection state is updated. The connection status message is shown on the form.
See Connect capability subflow for more details.
Starting with version 1.9, Discover action:
When discovering, an import request record is created and the subflow for the specific tool is called (as defined in the Integration Capability record). Detail and Status fields in the Import Request record are updated with the number of items discovered, updated, and failed.
The transformed payload consists of an array of objects as a JSON string. Elements vary depending on the tool type.
See Discover capability subflow for more details.
Note: Pagination is not supported in the Discover action for user-created integrations.
Starting with version 1.12, Import action:
Import action does not support historical import functionality.
Starting with version 1.12, Lookup action:
The Lookup main flow is provided to support artifact tool type in a subflow created by your integration developer.
Notification (webhook) action:
The source tool is configured manually (by your integration developer) to send raw data to the ServiceNow instance. The raw payload is then transformed into a standard JSON object using a subflow.
See the Notification capability subflow and the DevOps - POST /devops/tool/{capability} endpoint of the DevOps API for more details.

Note: Starting with version 1.11, if a subflow is not specified, default handling of notifications occurs (original payload is automatically copied to transformed payload).
This behavior is useful when the transactional data of the tool is supported by ServiceNow DevOps as is.
See the expected standard payloads in the Notification capability subflow for more details.

DevOps integration configuration overview

Tool integration configuration can be completed by your integration developer and your DevOps admin.

Integration developer

Create a tool integration record in DevOps to define the tool you are integrating (source tool).
Create a Flow Designer subflow to collect and transform data from the tool you are integrating (source tool).
Create a tool capability mapping record in DevOps to map the tool integration record to the tool type capability.
Note: Notifications (webhook) capability is supported. Starting with version 1.9, connect and discover capabilities are also supported.
Create an integration capability record in DevOps to specify the action for the tool type capability.

DevOps admin

Create a (planning, coding, or test) tool record in DevOps to connect to the tool you are integrating (source tool).
Note: The tool integration record must be specified in the Tool field of the tool record.
Configure the source tool with the webhook and credentials.

Inbound events

An inbound event serves as a staging area for the notifications flow that supports reprocessing of failed payloads. Meaning, a record in an error state from a failed integration or transformation can be retried.

If an Inbound Event record is in the Error state, the flow was not able to insert the record successfully into the core DevOps tables.

Common errors can be resolved with these actions.

Table 1. Inbound event error states
Error	Action
Missing required fields	The transformed payload does not match the standard payload. Refer to the standard and JSON payloads provided.
Repository not marked for tracking	The commit cannot be inserted. The DevOps admin needs to track the repository.
[Subflow] has not been published within application scope [app_scope]	The subflow is created but not published yet.
Timeout exception	The subflow takes more time than the value set in the property: com.glide.hub.flow_api.default_execution_time See FlowAPI - executeSubflowQuick(String name, Map inputs, Number timeout) for more details. Note: Starting with version 1.10, the execution of the subflow exceeds the value set in the Timeout field in the Integration Capability record.
Did not find a matching subflow for notification capability and [tool_integration_sys_id] tool integration	The flow was not able to find the matching subflow. Verify the integration setup procedure.
Payload does not match the expected capability.	The Original payload (payload being sent) is a different Capability type than the tool type capability configured in your tool capability mapping. The payload type must match the tool type capability configured in your tool integration.

Note: An inbound event record is not created when any of the following conditions occur:

Source tool has not passed the tool ID as a query parameter.
Source tool has passed on a tool ID, but there is no matching tool ID in the instance.

Tool mappings

A tool can be mapped to multiple capabilities.


Tool Integration	Tool Type Capability	Tool Capability Mapping
Agile Development 2.0 Azure DevOps Bitbucket GitHub GitHub Enterprise GitLab Jenkins Jira	Plan Code Orchestration Artifact Test	Plan Agile Development 2.0 - Plan Azure DevOps - Plan Jira - Plan Code Azure DevOps - Code Bitbucket - Code GitHub - Code GitHub Enterprise - Code GitLab - Code Orchestration Azure DevOps - Orchestration Jenkins - Orchestration GitLab - Orchestration Test Azure DevOps - Test Jenkins - Test

A tool capability mapping can be mapped to multiple actions.


Tool Capability Mapping	Tool Action	Integration Capability
Agile Development 2.0 - Plan Azure DevOps - Plan Azure DevOps - Code Azure DevOps - Orchestration Bitbucket - Code GitHub - Code GitHub Enterprise - Code GitLab - Code GitLab - Orchestration Jenkins - Orchestration Jira - Plan	Connect Discover Import Lookup Notification	Agile Development 2.0 Agile Development 2.0 - Plan - Connect Agile Development 2.0 - Plan - Discover Agile Development 2.0 - Plan - Import Agile Development 2.0 - Plan - Notification Azure DevOps Azure DevOps - Plan - Connect Azure DevOps - Plan - Discover Azure DevOps - Plan - Notification Azure DevOps - Code - Discover Azure DevOps - Code - Notification Azure DevOps - Orchestration - Discover Azure DevOps - Orchestration - Notification Bitbucket Bitbucket - Code - Connect Bitbucket - Code - Discover Bitbucket - Code - Import Bitbucket - Code - Notification GitHub GitHub - Code - Connect GitHub - Code - Discover GitHub - Code - Import GitHub - Code - Notification GitHub Enterprise GitHub - Code - Connect GitHub - Code - Discover GitHub - Code - Import GitHub - Code - Notification GitLab GitLab - Code - Connect GitLab - Code - Discover GitLab - Code - Notification GitLab - Orchestration - Notification Jenkins Jenkins - Orchestration - Connect Jenkins - Orchestration - Discover Jenkins - Orchestration - Import Jenkins - Orchestration - Notification Jira Jira - Plan - Connect Jira - Plan - Discover Jira - Plan - Import Jira - Plan - Notification

Multiple test types can be mapped to each tool integration.


Test Type	Tool Integration	Test Type Mapping
Unit: JUnit Functional: Integration Regression Smoke System User Acceptance Performance: Load	Azure DevOps Jenkins	Azure DevOps Azure DevOps - JUnit Azure DevOps - Integration Azure DevOps - Regression Azure DevOps - Smoke Azure DevOps - System Azure DevOps - User Acceptance Azure DevOps - Load Jenkins Jenkins - JUnit Jenkins - Integration Jenkins - Regression Jenkins - Smoke Jenkins - System Jenkins - User Acceptance Jenkins - Load

Previous topic

Next topic

Release version

User-created DevOps integrations

User-created integrations are for integrating additional planning, coding, and test tools not included in the integrations provided with the DevOps application.

Note: User-created integrations for orchestration tools is not supported.

DevOps integration objects

DevOps tool integration consists of these objects.

Tool capability actions

Starting with version 1.9, Connect action:
When connecting, the subflow for the specific tool is called and the connection state is updated. The connection status message is shown on the form.
See Connect capability subflow for more details.
Starting with version 1.9, Discover action:
When discovering, an import request record is created and the subflow for the specific tool is called (as defined in the Integration Capability record). Detail and Status fields in the Import Request record are updated with the number of items discovered, updated, and failed.
The transformed payload consists of an array of objects as a JSON string. Elements vary depending on the tool type.
See Discover capability subflow for more details.
Note: Pagination is not supported in the Discover action for user-created integrations.
Starting with version 1.12, Import action:
Import action does not support historical import functionality.
Starting with version 1.12, Lookup action:
The Lookup main flow is provided to support artifact tool type in a subflow created by your integration developer.
Notification (webhook) action:
The source tool is configured manually (by your integration developer) to send raw data to the ServiceNow instance. The raw payload is then transformed into a standard JSON object using a subflow.
See the Notification capability subflow and the DevOps - POST /devops/tool/{capability} endpoint of the DevOps API for more details.

Note: Starting with version 1.11, if a subflow is not specified, default handling of notifications occurs (original payload is automatically copied to transformed payload).
This behavior is useful when the transactional data of the tool is supported by ServiceNow DevOps as is.
See the expected standard payloads in the Notification capability subflow for more details.

DevOps integration configuration overview

Tool integration configuration can be completed by your integration developer and your DevOps admin.

Integration developer

Create a tool integration record in DevOps to define the tool you are integrating (source tool).
Create a Flow Designer subflow to collect and transform data from the tool you are integrating (source tool).
Create a tool capability mapping record in DevOps to map the tool integration record to the tool type capability.
Note: Notifications (webhook) capability is supported. Starting with version 1.9, connect and discover capabilities are also supported.
Create an integration capability record in DevOps to specify the action for the tool type capability.

DevOps admin

Create a (planning, coding, or test) tool record in DevOps to connect to the tool you are integrating (source tool).
Note: The tool integration record must be specified in the Tool field of the tool record.
Configure the source tool with the webhook and credentials.

Inbound events

If an Inbound Event record is in the Error state, the flow was not able to insert the record successfully into the core DevOps tables.

Common errors can be resolved with these actions.

Table 1. Inbound event error states
Error	Action
Missing required fields	The transformed payload does not match the standard payload. Refer to the standard and JSON payloads provided.
Repository not marked for tracking	The commit cannot be inserted. The DevOps admin needs to track the repository.
[Subflow] has not been published within application scope [app_scope]	The subflow is created but not published yet.
Timeout exception	The subflow takes more time than the value set in the property: com.glide.hub.flow_api.default_execution_time See FlowAPI - executeSubflowQuick(String name, Map inputs, Number timeout) for more details. Note: Starting with version 1.10, the execution of the subflow exceeds the value set in the Timeout field in the Integration Capability record.
Did not find a matching subflow for notification capability and [tool_integration_sys_id] tool integration	The flow was not able to find the matching subflow. Verify the integration setup procedure.
Payload does not match the expected capability.	The Original payload (payload being sent) is a different Capability type than the tool type capability configured in your tool capability mapping. The payload type must match the tool type capability configured in your tool integration.

Note: An inbound event record is not created when any of the following conditions occur:

Source tool has not passed the tool ID as a query parameter.
Source tool has passed on a tool ID, but there is no matching tool ID in the instance.

Tool mappings

A tool can be mapped to multiple capabilities.


Tool Integration	Tool Type Capability	Tool Capability Mapping
Agile Development 2.0 Azure DevOps Bitbucket GitHub GitHub Enterprise GitLab Jenkins Jira	Plan Code Orchestration Artifact Test	Plan Agile Development 2.0 - Plan Azure DevOps - Plan Jira - Plan Code Azure DevOps - Code Bitbucket - Code GitHub - Code GitHub Enterprise - Code GitLab - Code Orchestration Azure DevOps - Orchestration Jenkins - Orchestration GitLab - Orchestration Test Azure DevOps - Test Jenkins - Test

A tool capability mapping can be mapped to multiple actions.


Tool Capability Mapping	Tool Action	Integration Capability
Agile Development 2.0 - Plan Azure DevOps - Plan Azure DevOps - Code Azure DevOps - Orchestration Bitbucket - Code GitHub - Code GitHub Enterprise - Code GitLab - Code GitLab - Orchestration Jenkins - Orchestration Jira - Plan	Connect Discover Import Lookup Notification	Agile Development 2.0 Agile Development 2.0 - Plan - Connect Agile Development 2.0 - Plan - Discover Agile Development 2.0 - Plan - Import Agile Development 2.0 - Plan - Notification Azure DevOps Azure DevOps - Plan - Connect Azure DevOps - Plan - Discover Azure DevOps - Plan - Notification Azure DevOps - Code - Discover Azure DevOps - Code - Notification Azure DevOps - Orchestration - Discover Azure DevOps - Orchestration - Notification Bitbucket Bitbucket - Code - Connect Bitbucket - Code - Discover Bitbucket - Code - Import Bitbucket - Code - Notification GitHub GitHub - Code - Connect GitHub - Code - Discover GitHub - Code - Import GitHub - Code - Notification GitHub Enterprise GitHub - Code - Connect GitHub - Code - Discover GitHub - Code - Import GitHub - Code - Notification GitLab GitLab - Code - Connect GitLab - Code - Discover GitLab - Code - Notification GitLab - Orchestration - Notification Jenkins Jenkins - Orchestration - Connect Jenkins - Orchestration - Discover Jenkins - Orchestration - Import Jenkins - Orchestration - Notification Jira Jira - Plan - Connect Jira - Plan - Discover Jira - Plan - Import Jira - Plan - Notification

Multiple test types can be mapped to each tool integration.


Test Type	Tool Integration	Test Type Mapping
Unit: JUnit Functional: Integration Regression Smoke System User Acceptance Performance: Load	Azure DevOps Jenkins	Azure DevOps Azure DevOps - JUnit Azure DevOps - Integration Azure DevOps - Regression Azure DevOps - Smoke Azure DevOps - System Azure DevOps - User Acceptance Azure DevOps - Load Jenkins Jenkins - JUnit Jenkins - Integration Jenkins - Regression Jenkins - Smoke Jenkins - System Jenkins - User Acceptance Jenkins - Load

How search works:

Topics are ranked in search results by how closely they match your search terms

User-created DevOps integrations

User-created DevOps integrations

DevOps integration objects

Tool capability actions

DevOps integration configuration overview

Inbound events

Tool mappings

On this page

User-created DevOps integrations

User-created DevOps integrations

DevOps integration objects

Tool capability actions

DevOps integration configuration overview

Inbound events

Tool mappings

Log in to personalize your search results and subscribe to topics