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
Copy file name to clipboardExpand all lines: guides/build-plane-app.mdx
+20-4Lines changed: 20 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,9 +53,9 @@ To build an OAuth application with Plane:
53
53
2. Click on the **Build your own** button.
54
54
3. Fill out the form with the required details:
55
55
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.
56
+
-**Redirect URIs**: Provide the URIs where Plane will send the authorization code after the user consents to the app.
58
57
-**Contact Details**: Add your email or other contact information.
58
+
-**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.
59
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
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).
61
61
@@ -113,11 +113,19 @@ There are two types of authenticated actions your application can perform:
113
113
1.**User-authorized actions**: Actions performed on behalf of a user after they grant permission to your app via OAuth.
114
114
2.**App-authorized actions**: Actions that the app can perform independently within the workspace where it is installed (such as responding to webhooks or automation triggers).
115
115
116
+
For both these flows, Plane will make a GET request to the Redirect URI with parameters as mentioned in the following sections.
117
+
116
118
We will describe how to configure and use each type in the following sections.
When the app is installed, Plane will send an `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.
122
+
When the app is installed, Plane will send an `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.
123
+
124
+
Plane will make a GET request to the Redirect URI with below parameters:
125
+
126
+
| Parameter | Description |
127
+
|-----------|-------------|
128
+
| app_installation_id | The unique identifier for the app installation in the workspace |
In this flow, your app exchanges the `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.
204
+
In this flow, your app exchanges the `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.
205
+
206
+
Plane will make a GET request to the Redirect URI with below parameters:
207
+
208
+
| Parameter | Description | Required |
209
+
|-----------|-------------|----------|
210
+
| code | The authorization code that can be exchanged for an access token | Yes |
211
+
| state | The state parameter that was passed in the authorization request | No |
0 commit comments