Integrations
Get a list of all integrations and their status for the current user
GET /api/profile/integrations
Get a list of all integrations and their status for the current user
Returns
200
OK
curl -X get \ https://studio.fiberplane.com/api/profile/integrations \ -H 'Authorization: Bearer <YOUR_API_TOKEN>'
{ "type": "array", "items": { "type": "object", "required": [ "id", "status" ], "properties": { "id": { "type": "string", "enum": [ "github" ] }, "status": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "connected", "disconnected", "attention_required" ] }, "reason": { "type": "string", "description": "If `type = attention_required`, this field will be\npopulated with a human readable string explaining why\nattention is required for this peculiar integration\n" } } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }}
Get a list of al integrations and their status for the specified workspace
GET /api/workspaces/{workspaceId}/integrations
Get a list of al integrations and their status for the specified workspace
Path parameters
-
workspaceId
string base64uuid RequiredThe workspace ID
Returns
200
OK
curl -X get \ https://studio.fiberplane.com/api/workspaces/%7BworkspaceId%7D/integrations \ -H 'Authorization: Bearer <YOUR_API_TOKEN>'
{ "type": "array", "items": { "type": "object", "required": [ "id", "status" ], "properties": { "id": { "type": "string", "enum": [ "pagerdutywebhook", "githubapp" ] }, "status": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "connected", "disconnected", "attention_required" ] }, "reason": { "type": "string", "description": "If `type = attention_required`, this field will be\npopulated with a human readable string explaining why\nattention is required for this peculiar integration\n" } } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }}
Gets details about the GitHub app integration
GET /api/workspaces/{workspaceId}/integrations/github
Get details about the GitHub app integration
Path parameters
-
workspaceId
string base64uuid RequiredThe workspace ID
Returns
200
OK
default
Error
curl -X get \ https://studio.fiberplane.com/api/workspaces/%7BworkspaceId%7D/integrations/github \ -H 'Authorization: Bearer <YOUR_API_TOKEN>'
{ "type": "object", "required": [ "orgId", "orgName", "createdAt" ], "properties": { "orgId": { "type": "integer" }, "orgName": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }}
Install GitHub app to the current workspace
GET /api/workspaces/{workspaceId}/integrations/github/install
Install GitHub app to the current workspace
Path parameters
-
workspaceId
string base64uuid RequiredThe workspace ID
Returns
307
OK. Follow Location header
default
Error
curl -X get \ https://studio.fiberplane.com/api/workspaces/%7BworkspaceId%7D/integrations/github/install \ -H 'Authorization: Bearer <YOUR_API_TOKEN>'
Uninstall GitHub app on the current workspace
GET /api/workspaces/{workspaceId}/integrations/github/uninstall
Uninstall GitHub app on the current workspace
Path parameters
-
workspaceId
string base64uuid RequiredThe workspace ID
Returns
307
OK. Follow Location header
default
Error
curl -X get \ https://studio.fiberplane.com/api/workspaces/%7BworkspaceId%7D/integrations/github/uninstall \ -H 'Authorization: Bearer <YOUR_API_TOKEN>'