Step-by-step development guide to build and integrate an app with Plane using OAuth-based authentication and authorization workflow.
https://app.plane.so/<workspace_slug>/settings/applications/
.
POST
request to this endpoint upon every change to the workspace in which your app was installed.app_installation_id
as part of the callback to the Redirect URI provided during consent URL generation. You can use this app_installation_id
to request a bot token for your app.
Plane will make a GET request to the Redirect URI with below parameters:
Parameter | Description |
---|---|
app_installation_id | The unique identifier for the app installation in the workspace |
code
received as a query parameter on the callback (to your Redirect URI) for an access token and refresh token. The access token is short-lived and must be refreshed using the refresh token when it expires. Both tokens should be securely stored.
Plane will make a GET request to the Redirect URI with below parameters:
Parameter | Description | Required |
---|---|---|
code | The authorization code that can be exchanged for an access token | Yes |
state | The state parameter that was passed in the authorization request | No |
app_installation_id
identifies the app’s installation within a specific workspace. It is recommended that developers fetch workspace details after OAuth is successfully completed. Plane provides an app-installation
endpoint that works with both types of tokens.
Language | Package Link | Source Code |
---|---|---|
Node.js | npm i @makeplane/plane-node-sdk | plane-node-sdk |
Python | pip install plane-sdk | plane-python-sdk |