A guide to maintaining your product integrations

Building integrations is just the initial step in ensuring successful connectivity between applications over time.

You’ll also need to maintain the integrations as you onboard customers. Response bodies from API providers can vary wildly, and so every time you onboard a customer onto an integration, you are at risk of having your existing code throwing an error.

“Integration Maintenance'' is the work done by your engineers to fix bugs, edge cases, and unexpected errors caused by varying response bodies from third-party API through the entire lifecycle of your product.

These activities may seem trivial if you haven’t built an integration before. But when you have to perform them across dozens, if not hundreds, of integrations, the work can quickly overwhelm your in-house development team.

We’ll review the top challenges of integration maintenance, and how you can address them. But first, let’s align on the definition of application integration management.


What is integration maintenance?

It’s when your in-house development team performs a specific activity on an integration that’s already built. These activities can be performed on integrations that are either customer-facing (i.e. product integrations) or that support internal processes.

They’re often centered around resolving bugs or issues. For example, unexpected API responses being returned by a third party are a painful, well known cause of integration maintenance.

Related: What is an API integration strategy?

How are integration maintenance and management different?

Integration maintenance deals with changes to your code base and is done by engineers. Maintenance, though not always customer-facing, affects your customers by potentially leading to data quality issues.

Integration management relates to business operations that focus on how your customer interacts with their integration. This includes your customer success and engineering team’s response to issues with customer authentication, onboarding, or data normalization.

Both integration maintenance and management are similar in that they occur after the initial build of your integrations. Additionally, there is no ‘end’ to this work — it will always be required as long as you have customers.

Note: The rest of this article is focused on maintaining product integrations. However, many of the points below also apply to managing internal integrations.

Integration maintenance and management happen in two parallel cycles for the lifetime of integrations.

Challenges of integration maintenance

Until you encounter it, integration maintenance is underestimated work. Here are the top reasons it’s an ongoing burden.

Challenge 1: Unexpected edge cases and response bodies

Most engineering problems have an existing problem space. They have known outputs and inputs.

Integrations are a different problem: the inputs are completely unpredictable. You don’t control the returned third-party API data. The data your application ingests can be different not just across integrations, but even on the same platform. 

Your application has to programmatically and intelligently handle variable, unpredictable API response bodies at scale.

Related: 3 scenarios that can break your product integrations

Challenge 2: 3rd party support

When a problem does pop up in a 3rd party API, it’s often best to go to the source: that platform’s documentation.

Unfortunately, the documentation of 3rd party platforms is fine at best, and downright unhelpful at worst.

Here’s a nightmare scenario: you have an upset customer seeing incorrect data on one end, and a helpless engineer looking for the meaning of an error code on the other end. 

Dependence on external platforms, especially for customer-facing integrations, introduces risks due to their lack of obligation to support your product.

Related: Why support from 3rd-party APIs falls short of your wants and needs

Challenge 3: Long-term horizon

Ultimately, integration maintenance is so darn tough because it doesn’t end. 

Every new customer you onboard becomes a new test-case for how well you’ve built your integration up until now. Every new customer you onboard also becomes a risk for the on call engineer.

Your engineer organization has to be dedicated to maintaining integrations for the long haul.

Related: How performing integration maintenance on an ongoing basis can hurt your business

What to look for in a integration maintenance provider

Even if you leverage an embedded iPaaS solution, such as Workato or Tray.io, integration maintenance will still fall on your in-house development team.

Newer tools, such as Unified APIs, take on the full spectrum of maintenance for your engineers. Here’s what to look for when scoping a solution.

Experienced in-house integration team

Specialist and generalist skills are required to truly maintain integrations. Specialists are needed for the subject-matter expertise they bring for understanding how a given system works. For example, debugging an ERP system requires a deep understanding of accounting and related concepts. 

Generalists are critical because much of the underlying logic for managing integrations at scale can be applied to any type of integration, whether it’s in accounting, file storage, or CRM. Having experts in integrations as a field of development leads to faster response times and more robust integrations.

The right integration team can rapidly scale and maintain integrations for you.

Merge’s Partner Engineering team possesses a blend of business operations and engineering skills. This makes them well suited to not just solve, but proactively build the operations layer that keep Merge customer integrations healthy. 

Battle-tested with real customers

Remember how integrations aren’t a typical engineering problem? This is where “economies of scale” for integrations truly matter.

Only integration partners who have already seen millions of response bodies can accurately safe-guard against unexpected API responses and potentially breaking bugs. 

In a saturated Unified API market, having a proven track record of  battle-tested integrations serves as a meaningful moat.

Merge is used by over 10,000 organizations, including enterprise clients like Korn Ferry and Navan. Merge's integrations have handled over 80M API responses

Customer success and communication

Even with a third-party integration provider, bugs inevitably occur. Integrations are inherently reactive.

It's desirable to have a partner with a proven history of proactive communication, collaboration, and ultimately, customer satisfaction.

Leveraging platforms such as G2 or even your own networks is a great way to validate whether an integration provider is a right fit for your team. 

Let Merge maintain your integrations for you

Merge, the leading unified API solution, addresses all the maintenance capabilities outlined above (and much more) to keep your clients’ data safe and keep your engineers doing what they do best: building.

The platform also provides a variety of unified APIs for key software categories, from CRM to File Storage to HRIS, to ensure you can build all the integrations your customers want and need, quickly. 

You can learn more about Merge by scheduling a demo with one of our integration experts.