Plane Integration

Update Plane integration settings.

PUT

http://localhost:3000/api/integration/plane/settings

curl -X PUT 'http://localhost:3000/api/integration/plane/settings?organizationId=string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "mode": "shared",
  "planeWebUrl": "https://plane.example.com",
  "planeAdminUrl": "https://admin.plane.example.com",
  "planeSpaceUrl": "https://space.plane.example.com"
}'

const body = `{
  "mode": "shared",
  "planeWebUrl": "https://plane.example.com",
  "planeAdminUrl": "https://admin.plane.example.com",
  "planeSpaceUrl": "https://space.plane.example.com"
}`;

const response = await fetch('http://localhost:3000/api/integration/plane/settings?organizationId=string', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "mode": "shared",
  "planeWebUrl": "https://plane.example.com",
  "planeAdminUrl": "https://admin.plane.example.com",
  "planeSpaceUrl": "https://space.plane.example.com"
}'''

response = requests.put(
    'http://localhost:3000/api/integration/plane/settings?organizationId=string',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "mode": "shared",
  "planeWebUrl": "https://plane.example.com",
  "planeAdminUrl": "https://admin.plane.example.com",
  "planeSpaceUrl": "https://space.plane.example.com"
}

Body

application/json

modestringsharedcustom

Integration mode: "shared" uses the global hosted Ever Gauzy PM UIs, "custom" uses tenant-provided URLs

Example

shared

planeWebUrlstring

Main Plane web app URL (required only in custom mode)

Example

https://plane.example.com

planeAdminUrlstring

Plane admin panel URL (optional; not used in shared mode)

Example

https://admin.plane.example.com

planeSpaceUrlstring

Plane public space URL (required in custom mode)

Example

https://space.plane.example.com

Parameters

organizationIdstringrequiredquery

Response

200OK

Settings updated successfully.

404Not Found

Plane integration not configured.

Authorization

bearerhttp (bearer) in header

Enter JWT token

Stack Overflow Website Demo