Parallel Works
API Reference/GitHub/Configure GitHub App
put/api/platform/integrations/github

Configure GitHub App

This is a system-level route, so the response will be independent of the currently authenticated user.

This is a platform-admin only route.

Creates or updates the platform-level GitHub App configuration.

Operation ID: put-github-app-config

Request Body

Request Body

required
application/json
PutGitHubAppConfigInputBody
appId
required
integer(int64)

GitHub App ID

clientId
required
string

OAuth Client ID for user authentication

clientSecretstring

OAuth Client Secret (only sent when updating)

privateKeyPEMstring

Private key in PEM format (only sent when updating)

webhookSecretstring

Webhook secret for verifying GitHub webhook payloads (only sent when updating)

Responses

Responses

OK

GitHubAppConfigResponse
appId
required
integer(int64)
appName
required
string
appSlug
required
string
clientId
required
string
clientSecretConfigured
required
boolean
privateKeyConfigured
required
boolean
webhookSecretConfigured
required
boolean
Example Response
{
  "appId": 0,
  "appName": "string",
  "appSlug": "string",
  "clientId": "string",
  "clientSecretConfigured": true,
  "privateKeyConfigured": true,
  "webhookSecretConfigured": true
}

Example Request

cURL
curl -X PUT "https://activate.parallel.works/api/platform/integrations/github" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"key": "value"}'