Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Canvas is simple to use, but before diving in it can be a good idea to get to know some of the key concepts.

In this article we will describe three central concepts for Canvas: apps, blocks, and workflows.

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Summary:

  • Applications are used to store API credentials and to provide a simplified middle layer for working with external APIs. To create an integration you must first register the applications that you want to integrate with.

  • Blocks are modular pieces of code, used to build workflows. By combining pre-made or custom blocks you will be able to quickly develop the integration logic you need.

  • Workflows are integrations, built out of blocks. Workflows can be scheduled to run at given intervals, and they can be turned into templates for easy setup.

Table of Contents
minLevel1
maxLevel7

>>>>>Illustration<<<<<< How apps blocks and wfs relate

Applications

Canvas simplifies interaction with APIs by letting you register applications.

When you register a new application on a user account you will be asked to provide the necessary API credentials (usernames, passwords, API keys, etc) for the app. These details are then stored safely in the user account, and can be used by the integrations (“workflows”) that you create.

...

If you have worked with APIs before, you will know that it can be challenging to manually handle API authentication, safe storage of API credentials, refreshing of session tokens

...

, API changes, OAuth, etc.

Canvas simplifies all this by handling authentication and querying for you.

...

Session tokens are automatically refreshed, so you can build your integrations and interact with the API without having to think about authentication.

The applications in Canvas also have their own APIs, and thus work as a middle layer - simplifying and unifying the process of working with several external APIs. This means that you would (normally) not query external APIs directly. Instead you would query the app you registered

...

:

...

The app

...

Image Removed

APIs in Canvas will have similar endpoints to the external APIs, but will be much easier to work with.


For example, if you register Azure AD as an app on an account, then you will be able to set up integrations towards Azure AD using the stored credentials. Instead of querying the Azure AD API directly, you can query the app you registered , (without having to manage aspects such as authentication, etc).

...

This simplifies the process of building integrations while ensuring safe handling of sensitive data.

...

Blocks

Workflows:

Canvas philosophy

Legos for Image Removed