Integration Definition

What is it?

An integration definition represents an integration that is made available to end users via your product. These are typically what the end user would see listed in an integration or app marketplace or within your software product where it contextually makes sense. Think of your integration definitions as the registry of integrations you’ve built and make available to end users.

How is it used?

Use integration definitions to do the following:

  • Maintain a library or registry of the integrations that you make available from your application to others.
  • Provide the content for an integration or app marketplace experience that you expose to your users.
  • Communicate information to users about what business value an integration provides.
  • Provide a jumping off point for end users to set up a connection to the system defined by the integration definition.

Why is it important?

Integration definitions are the starting point for an end user. The end user’s mindset is to connect their data in your product to one or more other software products. They want to do that to automate a business process, unify data, or to accomplish some other cross-product experience.

Integration definitions relate to the following entities:

  • Integration definitions relate to one or more templates, which define the specific data flows that the integration supports.
  • Integration definitions relate to one or more connection types, which define how you can authenticate with the external application.
  • Integration definitions relate to one or more integration configs (which are also scoped to a single tenant) to represent a specific end user’s tenant having set up an instance of that integration.