Skip to navigation
Extension apps 101Extension app concepts

Connections

View as Markdown

A connection is the part of an extension app that defines the parameters required to access an external platform’s APIs. Typically, this will contain authorization data for the account that will make the API calls on that platform. To extend your workflow to multiple external platforms, you can register and apply multiple extension apps, one for each platform.

Define a connection in the extension app manifest

This JSON snippet demonstrates how to define a connection in an app manifest file. See Connection schema for more details.

"connections": [
    {
      "name": "authentication",
      "description": "Secure connection to example API proxy",
      "type": "oauth2",
      "params": {
        "provider": "CUSTOM",
        "scopes": [],
        "clientId": "6f22ef90-xxxx-xxxx-xxxx-e4be02783d3c",
        "clientSecret": "6cb7023b-xxxx-xxxx-xxxx-d1c4a56d1001",
        "customConfig": {
          "tokenUrl": "https://example.app/api/oauth/token",
          "authorizationUrl": "https://example.app/api/oauth/code",
          "authorizationParams": {
            "access_type": "offline",
            "prompt": "consent"
          },
          "authorizationMethod": "header",
          "scopeSeparator": " ",
          "requiredScopes": []
        }
      }
    }
  ]

Define a connection using a form

You can also define a connection using a form. After you have used a form to register your extension app, you can update the connection settings on the extension app’s integration details page.

Use the form to give the connection a unique name and configure the parameters required for authorization with the external platform including scopes, the OAuth2 endpoint, the client ID and secret, and any authorization query parameters. See Update connection settings for more details on how to configure these values.

A screenshot of the basic info section of the form-based experience for creating a connection A screenshot of the custom config section of the form-based experience for creating a connection

Next steps