registerAndOnboardSelfHostedGitHubApp

Examples

GraphQL

mutation RegisterAndOnboardSelfHostedGitHubApp($input: RegisterSelfHostedGitHubAppInput!, $installationId: Int!) {
  registerAndOnboardSelfHostedGitHubApp(input: $input, installationId: $installationId) {
    oxAppId
    appSlug
    appName
    installUrl
    webhookUrl
  }
}

Variables

This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.

{
  "input": {
    "gitHubAppId": "example",
    "privateKey": "example",
    "clientId": "example",
    "clientSecret": "example",
    "webhookSecret": "example",
    "baseUrl": "example",
    "credentialsName": "example",
    "brokerUsername": "example",
    "brokerPassword": "example",
    "brokerEnabled": true
  },
  "installationId": 42
}

cURL

curl -X POST \
https://api.cloud.ox.security/api/apollo-gateway \
-H 'Content-Type: application/json' \
-H 'Authorization: YOUR_API_TOKEN' \
-d '{
 "query": "mutation RegisterAndOnboardSelfHostedGitHubApp($input: RegisterSelfHostedGitHubAppInput!, $installationId: Int!) { registerAndOnboardSelfHostedGitHubApp(input: $input, installationId: $installationId) { oxAppId appSlug appName installUrl webhookUrl } }",
 "variables": {
    "input": {
      "gitHubAppId": "example",
      "privateKey": "example",
      "clientId": "example",
      "clientSecret": "example",
      "webhookSecret": "example",
      "baseUrl": "example",
      "credentialsName": "example",
      "brokerUsername": "example",
      "brokerPassword": "example",
      "brokerEnabled": true
    },
    "installationId": 42
  }
}'

Node.js

const query = 'mutation RegisterAndOnboardSelfHostedGitHubApp($input: RegisterSelfHostedGitHubAppInput!, $installationId: Int!) { registerAndOnboardSelfHostedGitHubApp(input: $input, installationId: $installationId) { oxAppId appSlug appName installUrl webhookUrl } }';

fetch("https://api.cloud.ox.security/api/apollo-gateway", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  body: JSON.stringify({
    query: query,
    // This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    variables: {
      input: {
        gitHubAppId: "example",
        privateKey: "example",
        clientId: "example",
        clientSecret: "example",
        webhookSecret: "example",
        baseUrl: "example",
        credentialsName: "example",
        brokerUsername: "example",
        brokerPassword: "example",
        brokerEnabled: true
      },
      installationId: 42
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

Python

import requests

query = 'mutation RegisterAndOnboardSelfHostedGitHubApp($input: RegisterSelfHostedGitHubAppInput!, $installationId: Int!) { registerAndOnboardSelfHostedGitHubApp(input: $input, installationId: $installationId) { oxAppId appSlug appName installUrl webhookUrl } }'

response = requests.post(
  "https://api.cloud.ox.security/api/apollo-gateway",
  headers={
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  json={
    "query": query,
    # This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    "variables": {
      "input": {
        "gitHubAppId": "example",
        "privateKey": "example",
        "clientId": "example",
        "clientSecret": "example",
        "webhookSecret": "example",
        "baseUrl": "example",
        "credentialsName": "example",
        "brokerUsername": "example",
        "brokerPassword": "example",
        "brokerEnabled": true
      },
      "installationId": 42
    }
  }
)

if response.status_code == 200:
    result = response.json()
    print(result)
else:
    print(f"Error: {response.status_code}")
    print(response.text)

Arguments

You can use the following argument(s) to customize your registerAndOnboardSelfHostedGitHubApp mutation.

Argument	Description	Supported fields
input RegisterSelfHostedGitHubAppInput! required		gitHubAppId String! privateKey String! clientId String! clientSecret String! webhookSecret String! baseUrl String credentialsName String brokerUsername String brokerPassword String brokerEnabled Boolean
installationId Int! required

Fields

Return type: RegisterSelfHostedGitHubAppResponse

You can use the following field(s) to specify what information your registerAndOnboardSelfHostedGitHubApp mutation will return. Please note that some fields may have their own subfields.

Field	Description	Supported fields
oxAppId String!	OX-internal identifier assigned to this registration
appSlug String!	GitHub App slug
appName String!	GitHub App display name
installUrl String!	URL customers use to install the app on their org/repos
webhookUrl String!	Webhook URL this app should deliver events to