GET /addon/{addon_key}/client-key

Get the client key of the Connect addon associated with a Forge app install via forgeAppId linkage.

This endpoint is part of the Connect -> Forge migration tooling. It is intended to be used by a Forge app using asApp().requestBitbucket() only. Prerequisite: app developer needs to register the linkage between their Connect and Forge app by setting forgeAppId in the Connect addon descriptor to app.id from Forge app manifest, then update the installations. If the request came from an installation of a registered Forge app, the client key of the linked Connect addon installed in the same workspace will be returned.

api.asApp().requestBitbucket(route`/2.0/addon/{addon-key}/client-key`)

Servers

Path parameters

Name Type Required Description
addon_key String Yes

The Connect addon key as defined in an application descriptor.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.