Azure DevOps Integration - Configuring Near Real-time

  • Updated

Azure DevOps Service Hooks (Webhooks) allow Azure DevOps to automatically notify OneConnect whenever a supported event occurs, such as a work item being created or updated. This enables near real-time synchronization, allowing changes to be processed shortly after they occur instead of waiting for the next scheduled synchronization. The result is faster updates and more up-to-date information across your connected systems.

Service Hooks are configured per Azure DevOps project. If your integration synchronizes multiple Azure DevOps projects, a Service Hook must be created for each project that you want to synchronize. Azure DevOps does not currently support configuring Service Hooks at the organization level.

Near Real-Time synchronization complements standard synchronization—it does not replace it. Standard synchronization is still required for initial data synchronization and scenarios such as creating new Plan records.

Pre-requisites

Before configuring near real-time synchronization, verify the following:

  • Your Azure DevOps integration is licensed with an Enterprise subscription in OneConnect.
    • Enterprise integrations include a unique Service Hook key that is used when configuring Azure DevOps.
    • The OnePlan OData ID must be set within the integrations OnePlan connector
  • You have permission to access Project Settings within the Azure DevOps project

Configure the OnePlan Group OData ID

For near real-time synchronization to function as expected, the OnePlan group OData ID must be configured in the OnePlan connector. 

To locate the OData ID:

  1. Sign into OnePlan.
  2. Navigate to the Admin page for the OnePlan group.
  3. Select the Integration tab.
  4. Locate the Reporting Info field.
  5. Copy the OData ID and enter it into the OData ID field in the OnePlan connector.

The OData ID is a unique identifier in the following format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Important: Near real-time synchronization will not function properly unless the OnePlan OData ID has been set.

Obtain the OneConnect Service Hook Key

  1. Sign in to OneConnect.
  2. Open the Azure DevOps integration.
  3. Select the Near Real-time tab.
  4. Copy the Service Hook Key (GUID) displayed on this page.

Note: The Service Hook Key is only available for Azure DevOps integrations that are licensed with an Enterprise subscription.

Configure a Service Hook in Azure DevOps

  1. Sign in to Azure DevOps.
  2. Open the Organization used by your integration (if there are more than one organization in your Azure DevOps environment).
  3. Select the Azure DevOps Project that you want to configure.
  4. Navigate to Project Settings.
  5. Under General, select Service Hooks.
  6. Click + Create Subscription.

Select the Service Hook Type

  1. Select Web Hooks.
  2. Click Next.

Select the Trigger

Choose one of the supported trigger events:

  • Work item created
  • Work Item updated

Note: These are the only trigger events currently supported for near real-time synchronization.

Click Next.

Configure the Service Hook

Complete the required fields:

  • URL: Enter the OneConnect service endpoint. 
    • My.OneConnect.ai endpoint: https://services.oneconnect.ai/receiveADOEvent
    • Eu.OneConnect.ai endpoint: https://services-eu.oneconnect.ai/receiveADOEvent
  • HTTP Headers: Add the following header: ApiKey: {Service Hook Key}
    • Replace the {Service Hook Key} segment with the value copied from the Near Real-time tab in OneConnect. 
    • HTTP Header should look similar to this: ApiKey: abdcefg1234567=

All remaining fields can be left with their default values.

Click Finish to create the Service Hook.

Note: Selecting Test before the Service Hook has been created and enabled may result in a failed test. This is expected behavior.

Viewing Near Real-time logs

Near real-time synchronization activity can be viewed from within the Azure DevOps integration.

  1. Open the integration in OneConnect.
  2. Expand the Logs menu.
  3. Select Near Real-time.

The log displays both currently running and completed synchronization request, making it easy to review processing history and troubleshoot synchronization issues.

Note: Near real-time logs are retained for the same number of days as events within your integration.

How Near Real-time Synchronization Works

Once near real-time synchronization has been configured, Azure DevOps will send updates to OneConnect whenever a supported event occurs. 

For near real-time to process these events successfully:

  • The Azure DevOps integration and OneConnect group must be enabled
  • The integration must be licensed with an Enterprise subscription. 
  • The OnePlan connector must be configured with the correct OnePlan OData ID
  • The Azure DevOps Service Hook must be enabled

When these requirements are met, OneConnect will process supported work item changes shortly after they occur. 

Important: Near real-time synchronization only processes changes to fields that are mapped within the integration. Changes made to unmapped fields do not trigger near real-time synchronization. 

Automatic Service Hook Management

If the Azure DevOps integration is disabled, or its Enterprise subscription is removed, OneConnect automatically rejects incoming near real-time requests. 

When this occurs, OneConnect instructs Azure DevOps to disable the corresponding Service Hook to prevent unnecessary requests from continuing to be sent. 

If the integration is later re-enabled, you must:

  1. Re-enable the Azure DevOps integration with an Enterprise subscription.
  2. Manually re-enable the Azure DevOps Service Hook(s) within each affected Azure DevOps project. 

Mind the Gap

Near real-time synchronization is designed to process changes to existing synchronized data. There are a few scenarios where a standard synchronization is still required.

Event-Level Filters are not Evaluated

Near Real-Time synchronization does not evaluate filters configured at the event level (Integration > Mappings > Filters).

Unlike a standard synchronization, Near Real-Time requests receive a limited set of information from Azure DevOps. Because not all work item fields are included in the notification, OneConnect cannot reliably evaluate event-level filters.

If your integration relies on event-level filters to determine which items should be synchronized, run a standard (scheduled or manual) synchronization instead.

Plan Records

Near real-time synchronization cannot create new Plan records in OnePlan.

If a newly created Azure DevOps work item will not be mapped to a OnePlan Plan, therefore, the plan must first be created by running a standard (scheduled or manual) synchronization. Once the plan has been created and linked, near real-time synchronization can process future updates to that plan.

If an update is received for a work item whose associated plan does not yet exist in OnePlan, the near real-time synchronization will fail because the required parent plan cannot be found.

Work Items

Near real-time synchronization can create and update Work Items, provided that the associated Plan already exists in OnePlan.

When a new work item is created in Azure DevOps under an existing synchronized plan, the work item will be created in OnePlan through near real-time synchronization. Likewise, updates to existing work items will be synchronized shortly after the changes occur.

If the parent plan has not yet been created in OnePlan, the work item cannot be created or updated through near real-time synchronization. In this scenario, run a standard synchronization to create the parent plan first. Once the plan exists and is linked, near real-time synchronization will successfully process future work item creations and updates.

Multiple Integrations

Near real-time synchronization is designed to be used with a single Azure DevOps integration per OnePlan group.

If multiple integrations are configured to synchronize the same OnePlan group, near real-time synchronization is not supported. Using near real-time in this configuration may result in duplicate processing, synchronization conflicts, or unexpected behavior.

If your OnePlan group is synchronized by multiple integrations, use standard (scheduled or manual) synchronization instead of near real-time synchronization.

Troubleshooting Near Real-time Synchronization

If near real-time is not processing changes as expected, verify the following:

  • The Azure DevOps project has a Service Hook configured and enabled. 
  • The correct trigger events (Work Item Created and/or Work Item Updated) have been configured. 
  • The integration is enabled and licensed with an Enterprise subscription. 
  • The OnePlan OData ID has been configured correctly. 
  • The updated field is mapped within the integration. 
  • The work item belongs to a plan that already exists and is connected to OnePlan. 

Common Log Messages

The following messages may appear in the OnePlanUpdate Near Real-Time strategy logs.

Near real-time task creation skipped: ParentId '{OnePlan ID}' is neither a valid plan nor a task in OnePlan. 

Meaning: OneConnect could not locate the parent item referenced by the incoming work item. 

Possible Causes:

  • The OnePlan OData ID is incorrect.
  • The parent work item is not connected to an existing OnePlan Plan. 

Plan is configured to be excluded from near real-time updates. Skipping...

Meaning: The associated plan exists in OnePlan but has been configured to ignore near real-time updates. 

Resolution: Within the plan's connected system window, click on Import, and check the "Include in near real-time updates" checkbox. To save those settings, click Import

Invalid Capability or DataTable was not specified in Strategy > Operation > Options.

Meaning: This Azure DevOps integration is not configured to support Near Real-Time synchronization. This typically occurs for integrations that were created before August 29, 2026, before Near Real-Time functionality became available.

Resolution: Create a Zendesk support ticket and request that your Azure DevOps integration be updated to support Near Real-Time synchronization.

Frequently Asked Questions

Why aren't my Azure DevOps changes appearing in OnePlan?

The most common causes are:

  • The Azure DevOps project does not have a Service Hook configured. 
  • The Service Hook has been disabled. 
  • The field that was updated is not mapped within the integration.
  • The OnePlan OData ID is incorrect. 
  • The parent plan does not yet exist in OnePlan. 
  • The integration is disabled or is no longer licensed with an Enterprise subscription. 

Because Service Hooks are configured per Azure DevOps project, each project included in your integration must have its own Service Hook configured and enabled. 

Was this article helpful?

0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.