Skip to content

create-oauth-application.md

Latest commit

 

History

History
31 lines (24 loc) · 1.75 KB

create-oauth-application.md

File metadata and controls

31 lines (24 loc) · 1.75 KB
title Create an OAuth Application
description Register your Plane OAuth application to get Client ID and Secret. Configure setup URL, redirect URI, and webhook endpoints for your integration.
keywords plane oauth application, create plane app, client id secret, plane app registration, oauth credentials, plane workspace integration, plane api authentication

Create an OAuth Application

  1. Navigate to Workspace Settings → Integrations.
https://app.plane.so/<workspace>/settings/integrations/
  1. Click Build your own.
  2. Fill in the required details:
Field Description
App Name Display name shown to users
Setup URL Entry point when users install your app. Your app redirects users to Plane's consent screen from here.
Redirect URI Callback URL where Plane sends users after they approve access, along with the authorization code.
Webhook URL Endpoint for receiving event notifications
  1. For agents that respond to @mentions, enable "Enable App Mentions".
  2. Save and store your Client ID and Client Secret securely.
  3. Select the scopes you need for your app from the Scopes & Permissions section. See OAuth Scopes for more information on the available scopes.

::: warning Never expose your Client Secret in client-side code or commit it to version control. :::