Skip to navigation

Changelog

August 8, 2024

New Webhook: App Installed

Starting September 10th, 2024, (shareable) apps receive a webhook when the app is installed on any Benchling tenant.

The webhook is triggered when clicking the “Install” or “Upgrade” button on the app’s install page:

Install page with 'Install' button

Install page with 'Upgrade' button The app version is included in the payload, letting you determine if a tenant is installing the app for the first time or upgrading from an earlier version of the app.

The full payload for the v2.app.installed webhook:

{  
    "version": "0",  
    "baseURL": "<https://staging.bnchdev.org">,  
    "tenantId": "ten_qka2rgzb1k",  
    "app": {  
        "id": "app_M4YccSZUlgtmwv4P"  
    },  
    "appDefinition": {  
        "id": "appdef_XsmKVPMYtc",  
        "versionNumber": "0.1.1"  
    },  
    "channel": "app_signals",  
    "message": {  
        "type": "v2.app.installed",  
        "deprecated": false  
    }  
}

Any app with a valid webhook URL will automatically subscribe to this webhook.

[Sunset] Installation-based App Manifest Endpoints

The v2-beta endpoints for Benchling App Manifests that use app installation IDs will be sunset on September 6, 2024. Please use the new equivalent endpoints that operate using app definition IDs instead, which are also in v2-beta stability.

What’s changing?

The v2-beta endpoints for Benchling App Manifests that operate using app installation IDs are being sunset in favor of equivalently-functioning endpoints that use the app definition ID instead. Since the App Manifest represents an App Definition Version, version IDs will be required in the new endpoint path as well. No functionality is being lost by migrating to the new endpoints. Each endpoint and its corresponding counterpart is below:

Get Manifest:

  • removed: v2-beta/apps/<app_id>/manifest.yaml
  • equivalent: v2-beta/app-definitions/<app_def_id>/versions/<version_id>/manifest.yaml

Put Manifest:

  • removed: v2-beta/apps/<app_id>/manifest.yaml
  • equivalent: v2-beta/app-definitions/<app_def_id>/versions/<version_id>/manifest.yaml

When is this happening?

The new endpoints are available now! The manifest endpoints to be deprecated are currently marked as such, and will be fully sunset on September 6, 2024.