Skip to content

Commit f694b53

Browse files
add parameters for each section
1 parent 85267b7 commit f694b53

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

guides/build-plane-app.mdx

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ To build an OAuth application with Plane:
5353
2. Click on the **Build your own** button.
5454
3. Fill out the form with the required details:
5555

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.
5857
- **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.
5959
- **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.
6060
- **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).
6161

@@ -113,11 +113,19 @@ There are two types of authenticated actions your application can perform:
113113
1. **User-authorized actions**: Actions performed on behalf of a user after they grant permission to your app via OAuth.
114114
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).
115115

116+
For both these flows, Plane will make a GET request to the Redirect URI with parameters as mentioned in the following sections.
117+
116118
We will describe how to configure and use each type in the following sections.
117119

118120
### App-Authorized Actions (Client Credentials Flow)
119121

120-
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 |
121129

122130
#### Examples
123131

@@ -193,7 +201,15 @@ const expiresIn = responseData.expires_in;
193201

194202
### User-Authorized Actions (Authorization Code Flow)
195203

196-
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 |
212+
197213

198214
#### Examples
199215

0 commit comments

Comments
 (0)