\n \n \n appId\n | \n \n number\n | \n \n Required. Find the App ID on the app’s about page in settings.\n | \n
\n \n \n privateKey\n | \n \n string\n | \n \n Required. Content of the *.pem file you downloaded from the app’s about page. You can generate a new private key if needed.\n | \n
\n \n \n Octokit\n | \n \n Constructor\n | \n \n\nYou can pass in your own Octokit constructor with custom defaults and plugins. Note that `authStrategy` will be always be set to `createAppAuth` from [`@octokit/auth-app`](https://github.com/octokit/auth-app.js).\n\nFor usage with enterprise, set `baseUrl` to the hostname + `/api/v3`. Example:\n\n```js\nconst { Octokit } = require(\"@octokit/core\");\nnew App({\n appId: 123,\n privateKey: \"-----BEGIN PRIVATE KEY-----\\n...\",\n oauth: {\n clientId: 123,\n clientSecret: \"secret\",\n },\n webhooks: {\n secret: \"secret\",\n },\n Octokit: Octokit.defaults({\n baseUrl: \"https://ghe.my-company.com/api/v3\",\n }),\n});\n```\n\nDefaults to [`@octokit/core`](https://github.com/octokit/core.js).\n\n |
\n \n \n log\n | \n \n object\n | \n \n Used for internal logging. Defaults to console.\n | \n
\n \n \n webhooks.secret\n | \n \n string\n | \n \n Required. Secret as configured in the GitHub App's settings.\n | \n
\n \n \n webhooks.transform\n | \n \n function\n | \n \n Only relevant for `app.webhooks.on`. Transform emitted event before calling handlers. Can be asynchronous. \n | \n
\n \n \n oauth.clientId\n | \n \n number\n | \n \n Find the OAuth Client ID on the app’s about page in settings.\n | \n
\n \n \n oauth.clientSecret\n | \n \n number\n | \n \n Find the OAuth Client Secret on the app’s about page in settings.\n | \n
\n \n \n oauth.allowSignup\n | \n \n boolean\n | \n \n Sets the default value for app.oauth.getAuthorizationUrl(options).\n | \n
\n \n