Skip to main content

Custom integrations

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 a configuration app so Uniform can include the custom user interface to Canvas users.

tip

The custom integration tutorials provide step-by-step instructions that guide you through the entire process of building and deploying custom integrations.

tip

For more information about what you can do with custom integrations, see the custom integrations section under Uniform capabilities.

Register integration

Custom integrations are registered using the Uniform app.

info

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

  1. In Uniform, navigate to your team's Settings > Custom Integrations.

    settings
  2. Click ADD INTEGRATION.

    create-team-integration-form
  3. 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 team home page. The value you enter in Location Configuration is used to control other aspects of the user interface.

    values
    tip

    For details about the options available for location configuration, see the Canvas reference.

  4. Click Save.

    custom-integration-added
    About this step

    Your custom integration will appear in the list of custom integrations.

Next steps

Now you can assign the integration to your project.

Assign integration to 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. In Uniform, open your project.

  2. Navigate to the Integrations tab.

  3. Scroll to the section Browse Integrations.

    browse-integrations
  4. Click the integration you want to add.

Remove integration from team

  1. In Uniform, navigate to the teams dashboard.

    About this step

    This is the dashboard you see when you log into Uniform. You can return to it by clicking the Uniform logo in the upper left-hand corner of the application.

  2. Navigate to Settings > Custom Integrations.

  3. In the ADDED INTEGRATIONS section, find the row that represents the integration you want to remove.

  4. Find the integration you want to remove and click Edit.

  5. Click ...

  6. Click Delete Integration.

    delete-confirmation
  7. Follow the instructions and click Delete.