Integration Definitions

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.


  • name: The name of this integration
  • description: A brief description
  • templates: The ids of templates that belong to this integration definition
  • data: Data you wish to associate with this integration definition and use in your marketplace listing
  • connectionTypes: An array of connection ids

Note: When making GET requests, templates and connectionTypes will contain the template and connection objects corresponding to each ID, rather than the IDs themselves.