You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -54,18 +54,23 @@ To build an OAuth application with Plane:
54
54
3. Fill out the form with the required details:
55
55
56
56
-**Redirect URIs**: Provide the URIs where Plane will send the authorization code.
57
+
-**Setup URL(Optional)**: Provide the URL that users will be redirected to when they click "Install App" from the marketplace. This URL should initiate the OAuth flow for your application.
57
58
-**Contact Details**: Add your email or other contact information.
58
-
-**Webhook URL Endpoint**: Update this with your service's webhook endpoint. Plane will send webhooks for all changes that happen in the installed workspace.
59
-
-**Organization Details**: Include contact email, privacy policy URL, terms of service URL, and any other relevant information. This helps Plane validate and approve your application for listing in the marketplace.
59
+
-**Webhook URL Endpoint(Optional)**: Your service's webhook endpoint. Plane will send an HTTP `POST` request to this endpoint upon every change to the workspace in which your app was installed.
60
+
-**Organization Details(Optional)**: Optionally include your contact email, privacy policy URL, terms of service URL, and any other relevant information. This helps Plane validate and approve your application should you choose to [list in the marketplace](#listing-your-app-on-plane-marketplace).
60
61
61
62
4. If you're building an agent (with or without using Plane's ADK) capable of performing operations when assigned or mentioned, enable the **Is Mentionable** checkbox during app creation.
62
-
5. Once the app is created, securely store the **Client ID** and **Client Secret**. You will need these credentials to interact with Plane's API during the OAuth flow and for making authenticated API requests.
63
+
5. Once the app is created, securely store the generated **Client ID** and **Client Secret**. You will need these credentials to interact with Plane's API during the OAuth flow and for making authenticated API requests.
63
64
64
-
## Authentication Setup
65
+
## Implement OAuth Flow
65
66
66
-
### Generating Consent URL
67
+
### Generating Consent URL (Optional)
67
68
68
-
Before handling authentication, if your app manages installation, you must generate the consent (authorization) URL to initiate the OAuth flow. Below are sample implementations:
69
+
This step is optional. This is needed only if the app should be installed from outside Plane's environment, the developer needs to generate the consent URL using the client ID generated during their app creation flow.
70
+
71
+
If this flow needs to be triggered from Plane marketplace as well, then provide the URL in "Setup URL" field on application create screen to redirect the user from marketplace on clicking "Install App" button.
To simplify the OAuth flow and make it easier to build Plane apps, official SDKs are available:
348
+
349
+
## Obtain and store access tokens securely
350
+
351
+
Once you have obtained the access token, you can use it to make authenticated API requests to Plane.
352
+
Store the access token and refresh token securely in your database.
353
+
354
+
355
+
## Make authenticated API requests to Plane
356
+
357
+
For making authenticated API requests to Plane, you can use the access token obtained from the OAuth flow.
358
+
359
+
API reference is available at [https://docs.plane.so/api-reference](https://docs.plane.so/api-reference).
360
+
361
+
We have official SDKs for the following languages to simplify the OAuth flow and make it easier to call Plane's API.
385
362
386
363
| Language | Package Link | Source Code |
387
364
|----------|---------|-------------|
388
365
| Node.js |[npm i @makeplane/plane-node-sdk](https://www.npmjs.com/package/@makeplane/plane-node-sdk)|[plane-node-sdk](https://github.com/makeplane/plane-node-sdk)|
0 commit comments