Skip to main content

Concepts

Uniform comes with a large set of prebuild integrations that allow you to build your own composable stack without having to build connectors yourself. However, you may need to integrate systems that Uniform has not built integrations for. The Uniform Mesh SDK enables you to build your own integrations for such systems.

tip

If you prefer to jump directly to writing code, go to the custom integration tutorial.

Building your own integration involves the following concepts:

  • Configuration app - A web application provides the user interface for your integration.
  • Registration - Registering a custom integration makes the integration available to Canvas users.
  • Locations - Canvas users need the ability to configure and use your integration. The Uniform dashboard supports a number of locations where custom user interfaces can be added in order to provide this functionality. Locations map to routes in the configuration app.
  • Design system - The Uniform dashboard is built using components from the Uniform design system. You can use this design system to ensure your integration matches the Uniform Canvas loook and feel.
  • Enhancers - In most cases, a custom integration allows a Uniform Canvas user to identify content or information from another system to be incorporated into digital experiences whose presentation is controlled using Canvas. But the Canvas user is only creating a reference to the source system. An enhancer is a component that retrieves the actual content or information from the source system when it's needed (e.g. when a website's build process runs).