Skip to main content

Registration

Your custom integration must be registered with your Uniform team. Registration involves providing Uniform with the information it needs to expose your custom integration to Canvas users. Registration points Uniform to the configuration app so Uniform can include the custom user interface to Canvas users.

Register integration​

Custom integrations are registered using the Uniform Dashboard.

info

A user must be assigned to the Admin role in order to register custom integrations.

  1. In Uniform, navigate to a project.

  2. Navigate to Settings > Integrations

  3. Scroll to the section Manage Team Integrations

  4. Click Create a new team integration

  5. The values you enter in the fields for Name, Badge Icon Url and Logo Icon Url determine how your custom integration is displayed in the Uniform dashboard. The value you enter in Location Configuration is used to control other aspects of the user interface (see below for details).

Assign integration to a project​

While a custom integration is registered from within a project, it is available to all projects in your Uniform team. Custom integrations can be assigned to any project in your team the same way any other integration is assigned.

  1. Scroll to the section Available integrations

  2. Click the + icon.

Configure locations​

The specific places in the Uniform dashboard where your custom integration appears are configured using the Location Configuration field from the team integration configuration form. The following describes the JSON object used to specify this configuration.

Attributes
baseLocationUrlurl
The prefix for relative urls specified in the locations section.
locationsobject
The places in the Uniform dashboard where the custom integration is used.
＋ show child attributes
For more information, see Locations.
Example
{
  "baseLocationUrl": "https://myintegration.app",
  "locations": {
    "canvas": {
      "parameterTypes": [
        {
          "type": "parameter-1",
          "editorUrl": "/parameter-1-editor",
          "displayName": "Parameter 1",
          "configureUrl": "/parameter-1-config"
        }
      ]
    },
    "install": {
      "description": [
        "This describes what the integration does."
      ]
    },
    "settings": {
      "url": "/settings"
    }
  }
}