added

App Canvas direct embed available for notebook entries and templates

App Canvases can now be inserted directly into Notebook entries and Notebook templates! Check out our updated Introduction to App Canvas for more details.

What's changing?

Previously, App Canvas only supported the APP_HOMEPAGE and ASSAY_RUN feature types. This meant that canvases could only be embedded in two places in Benchling: On an app's homepage, or in a Benchling Connect run. This limitation made using App Canvas to build dynamic UIs in Benchling more challenging, and inserting canvases into the Notebook wasn't possible for customers that did not use Benchling Connect.

With the new GA of embeddable canvases, we've introduced a new feature type: CANVAS. The CANVAS feature type represents the places in Benchling that support a direct canvas embed; this includes notebook entries and templates, as well as other similar tools like Recipes.

Specifically, the following changes to support canvas direct embed are now live:

  • The type field of features defined in an app manifest now supports the CANVAS type
  • features defined in an app manifest now has an optionallocations field for the features of type CANVAS
    • Currently, locations supports a value of ENTRY or ENTRY_TEMPLATE
  • The v2-beta.canvas.created webhook type is now available in the subscriptions field of an app manifest
    • The v2-beta.canvas.created webhook is triggered when a canvas is created inside a Notebook entry

When is this happening?

The CANVAS feature and embeddable canvas is available now! You can learn more at our updated Introduction to App Canvas guide.