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 know some of the key concepts.

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

Table of Contents
minLevel1
maxLevel7
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.

...

Applications

Canvas simplifies interaction with APIs by letting you register applications.

...

  • 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, OAuth, API changes, etc.
    Canvas simplifies all this by handling authentication and querying for you.

  • In Canvas, you do not normally query external APIs directly. Instead you would query the app you registered. The app API on Canvas works as a middle layer, simplifying and unifying the process of working with several external APIs.

Image RemovedImage Added


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.

...