{"bugs":{"url":"https://github.com/octokit/webhooks/issues"},"dist":{"shasum":"f476a89066dc508bb4dc1cb09a946c23b5d40998","tarball":"https://registry.npmjs.org/@octokit/webhooks-definitions/-/webhooks-definitions-3.68.0.tgz","fileCount":7,"integrity":"sha512-l3Z7DdWxP8QfOlawRPE8jvketeDhF2Q3xCNbkYVNgo2ni0NHDMwplVQT6o6ZER8myBUpHkBXP4MjgrEgLScFVQ==","signatures":[{"sig":"MEUCIQCdTKpiMqjFmlG2YyjFhuoOXB9dMkmcXCbdR9yTpHbDOQIgaRjcwsTHFGyv8Zr6uc0LpN/1Xwdqi2uBeObm0nPzYQ4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":4039122,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgeuW0CRA9TVsSAnZWagAAKCoP/12xdGpeDz75wzSqzJfk\nhuw69xULtcpbgIoJ/rZUGR++i2Fz+e0zm0rI5F48dhYIY28fOx317+ea5LK4\nKJqWqundo5xAW9eDfJRWcfJiqQaMonVzMy9UF2G8jVpZGFwK5n2X2BweZ3jZ\nRMRxXuyd/rl3L0aGrRK6yLSZgOt8QPWk6ACzjtx78B/bgchZ95EM1Jh8+foq\nwLrU1t4HxEm2fHjNiQ3lUkTL1lm1QOq4VyJL6pXiiSzSq3UeXfdqZ/DWSSoC\nhprGmlzx+CAlYUwCnItg3r6RunCd8vxi89ImQsNMRVWp75JOxgZ606C9bKK2\nHxl9oUdUAnXXnIfTEPIWLo1ADXJXQAemS1JlkYaqvMx3pZFR1habbAG4OlBi\nT88bHH2WA1Ewmwio0XIkcI6zAtocA7trfmuh/gL3kmzG9tAdL05mhKIEwwn9\nDbVg9uhhxI/mJLCst++zHhWiidvgyfSDnOut+H1y5qn4g2z2VB0vsmN0XcRA\ntrZWsgn/rfCJPqzAmRfg/MwuIGgEfKcgxvb686QDBqffbZ1nuElvyBMkzbMi\nH9Q99c4AXXR1y3Nyte+i6SRnDyqZxf/CTS7CW+gLhYrBq/4qISycVOxshdAI\nEkjRflhmr9tgUZw9VChnV1u/VXC0idYosqkwf5PKRzgKnPIkY0cm3CT16di0\no57L\r\n=ZWNd\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.json","name":"@octokit/webhooks-definitions","author":{"url":"https://github.com/gr2m","name":"Gregor Martynus"},"readme":"# Octokit Webhooks\n\n> machine-readable, always up-to-date GitHub Webhooks specifications\n\n![Update status](https://github.com/octokit/webhooks/workflows/Update/badge.svg)\n\n## Download\n\nDownload the latest specification at\n[octokit.github.io/webhooks/index.json](https://octokit.github.io/webhooks/index.json)\n\n## Example\n\nExample webhook definition\n\n```json\n{\n  \"name\": \"issues\",\n  \"actions\": [\n    \"opened\",\n    \"edited\",\n    \"deleted\",\n    \"transferred\",\n    \"closed\",\n    \"reopened\",\n    \"assigned\",\n    \"unassigned\",\n    \"labeled\",\n    \"unlabeled\",\n    \"milestoned\",\n    \"demilestoned\"\n  ],\n  \"examples\": [\n    {\n      \"action\": \"edited\",\n      \"issue\": {\n        \"url\": \"https://api.github.com/repos/Codertocat/Hello-World/issues/2\",\n        \"repository_url\": \"https://api.github.com/repos/Codertocat/Hello-World\",\n        \"labels_url\": \"https://api.github.com/repos/Codertocat/Hello-World/issues/2/labels{/name}\",\n        \"comments_url\": \"https://api.github.com/repos/Codertocat/Hello-World/issues/2/comments\",\n        \"events_url\": \"https://api.github.com/repos/Codertocat/Hello-World/issues/2/events\",\n        \"html_url\": \"https://github.com/Codertocat/Hello-World/issues/2\",\n        \"id\": 327883527,\n        \"node_id\": \"MDU6SXNzdWUzMjc4ODM1Mjc=\",\n        \"number\": 2,\n        \"title\": \"Spelling error in the README file\",\n        \"user\": {\n          \"login\": \"Codertocat\",\n          \"id\": 21031067,\n          \"node_id\": \"MDQ6VXNlcjIxMDMxMDY3\",\n          \"avatar_url\": \"https://avatars1.githubusercontent.com/u/21031067?v=4\",\n          \"gravatar_id\": \"\",\n          \"url\": \"https://api.github.com/users/Codertocat\",\n          \"html_url\": \"https://github.com/Codertocat\",\n          \"followers_url\": \"https://api.github.com/users/Codertocat/followers\",\n          \"following_url\": \"https://api.github.com/users/Codertocat/following{/other_user}\",\n          \"gists_url\": \"https://api.github.com/users/Codertocat/gists{/gist_id}\",\n          \"starred_url\": \"https://api.github.com/users/Codertocat/starred{/owner}{/repo}\",\n          \"subscriptions_url\": \"https://api.github.com/users/Codertocat/subscriptions\",\n          \"organizations_url\": \"https://api.github.com/users/Codertocat/orgs\",\n          \"repos_url\": \"https://api.github.com/users/Codertocat/repos\",\n          \"events_url\": \"https://api.github.com/users/Codertocat/events{/privacy}\",\n          \"received_events_url\": \"https://api.github.com/users/Codertocat/received_events\",\n          \"type\": \"User\",\n          \"site_admin\": false\n        },\n        \"labels\": [\n          {\n            \"id\": 949737505,\n            \"node_id\": \"MDU6TGFiZWw5NDk3Mzc1MDU=\",\n            \"url\": \"https://api.github.com/repos/Codertocat/Hello-World/labels/bug\",\n            \"name\": \"bug\",\n            \"color\": \"d73a4a\",\n            \"default\": true\n          }\n        ],\n        \"state\": \"open\",\n        \"locked\": false,\n        \"assignee\": null,\n        \"assignees\": [\n          {\n            \"login\": \"Codertocat\",\n            \"id\": 21031067,\n            \"node_id\": \"MDQ6VXNlcjIxMDMxMDY3\",\n            \"avatar_url\": \"https://avatars1.githubusercontent.com/u/21031067?v=4\",\n            \"gravatar_id\": \"\",\n            \"url\": \"https://api.github.com/users/Codertocat\",\n            \"html_url\": \"https://github.com/Codertocat\",\n            \"followers_url\": \"https://api.github.com/users/Codertocat/followers\",\n            \"following_url\": \"https://api.github.com/users/Codertocat/following{/other_user}\",\n            \"gists_url\": \"https://api.github.com/users/Codertocat/gists{/gist_id}\",\n            \"starred_url\": \"https://api.github.com/users/Codertocat/starred{/owner}{/repo}\",\n            \"subscriptions_url\": \"https://api.github.com/users/Codertocat/subscriptions\",\n            \"organizations_url\": \"https://api.github.com/users/Codertocat/orgs\",\n            \"repos_url\": \"https://api.github.com/users/Codertocat/repos\",\n            \"events_url\": \"https://api.github.com/users/Codertocat/events{/privacy}\",\n            \"received_events_url\": \"https://api.github.com/users/Codertocat/received_events\",\n            \"type\": \"User\",\n            \"site_admin\": false\n          }\n        ],\n        \"milestone\": null,\n        \"comments\": 0,\n        \"created_at\": \"2018-05-30T20:18:32Z\",\n        \"updated_at\": \"2018-05-30T20:18:32Z\",\n        \"closed_at\": null,\n        \"author_association\": \"OWNER\",\n        \"body\": \"It looks like you accidently spelled 'commit' with two 't's.\"\n      },\n      \"changes\": {},\n      \"repository\": {\n        \"id\": 135493233,\n        \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=\",\n        \"name\": \"Hello-World\",\n        \"full_name\": \"Codertocat/Hello-World\",\n        \"owner\": {\n          \"login\": \"Codertocat\",\n          \"id\": 21031067,\n          \"node_id\": \"MDQ6VXNlcjIxMDMxMDY3\",\n          \"avatar_url\": \"https://avatars1.githubusercontent.com/u/21031067?v=4\",\n          \"gravatar_id\": \"\",\n          \"url\": \"https://api.github.com/users/Codertocat\",\n          \"html_url\": \"https://github.com/Codertocat\",\n          \"followers_url\": \"https://api.github.com/users/Codertocat/followers\",\n          \"following_url\": \"https://api.github.com/users/Codertocat/following{/other_user}\",\n          \"gists_url\": \"https://api.github.com/users/Codertocat/gists{/gist_id}\",\n          \"starred_url\": \"https://api.github.com/users/Codertocat/starred{/owner}{/repo}\",\n          \"subscriptions_url\": \"https://api.github.com/users/Codertocat/subscriptions\",\n          \"organizations_url\": \"https://api.github.com/users/Codertocat/orgs\",\n          \"repos_url\": \"https://api.github.com/users/Codertocat/repos\",\n          \"events_url\": \"https://api.github.com/users/Codertocat/events{/privacy}\",\n          \"received_events_url\": \"https://api.github.com/users/Codertocat/received_events\",\n          \"type\": \"User\",\n          \"site_admin\": false\n        },\n        \"private\": false,\n        \"html_url\": \"https://github.com/Codertocat/Hello-World\",\n        \"description\": null,\n        \"fork\": false,\n        \"url\": \"https://api.github.com/repos/Codertocat/Hello-World\",\n        \"forks_url\": \"https://api.github.com/repos/Codertocat/Hello-World/forks\",\n        \"keys_url\": \"https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}\",\n        \"collaborators_url\": \"https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}\",\n        \"teams_url\": \"https://api.github.com/repos/Codertocat/Hello-World/teams\",\n        \"hooks_url\": \"https://api.github.com/repos/Codertocat/Hello-World/hooks\",\n        \"issue_events_url\": \"https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}\",\n        \"events_url\": \"https://api.github.com/repos/Codertocat/Hello-World/events\",\n        \"assignees_url\": \"https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}\",\n        \"branches_url\": \"https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}\",\n        \"tags_url\": \"https://api.github.com/repos/Codertocat/Hello-World/tags\",\n        \"blobs_url\": \"https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}\",\n        \"git_tags_url\": \"https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}\",\n        \"git_refs_url\": \"https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}\",\n        \"trees_url\": \"https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}\",\n        \"statuses_url\": \"https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}\",\n        \"languages_url\": \"https://api.github.com/repos/Codertocat/Hello-World/languages\",\n        \"stargazers_url\": \"https://api.github.com/repos/Codertocat/Hello-World/stargazers\",\n        \"contributors_url\": \"https://api.github.com/repos/Codertocat/Hello-World/contributors\",\n        \"subscribers_url\": \"https://api.github.com/repos/Codertocat/Hello-World/subscribers\",\n        \"subscription_url\": \"https://api.github.com/repos/Codertocat/Hello-World/subscription\",\n        \"commits_url\": \"https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}\",\n        \"git_commits_url\": \"https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}\",\n        \"comments_url\": \"https://api.github.com/repos/Codertocat/Hello-World/comments{/number}\",\n        \"issue_comment_url\": \"https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}\",\n        \"contents_url\": \"https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}\",\n        \"compare_url\": \"https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}\",\n        \"merges_url\": \"https://api.github.com/repos/Codertocat/Hello-World/merges\",\n        \"archive_url\": \"https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}\",\n        \"downloads_url\": \"https://api.github.com/repos/Codertocat/Hello-World/downloads\",\n        \"issues_url\": \"https://api.github.com/repos/Codertocat/Hello-World/issues{/number}\",\n        \"pulls_url\": \"https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}\",\n        \"milestones_url\": \"https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}\",\n        \"notifications_url\": \"https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}\",\n        \"labels_url\": \"https://api.github.com/repos/Codertocat/Hello-World/labels{/name}\",\n        \"releases_url\": \"https://api.github.com/repos/Codertocat/Hello-World/releases{/id}\",\n        \"deployments_url\": \"https://api.github.com/repos/Codertocat/Hello-World/deployments\",\n        \"created_at\": \"2018-05-30T20:18:04Z\",\n        \"updated_at\": \"2018-05-30T20:18:10Z\",\n        \"pushed_at\": \"2018-05-30T20:18:30Z\",\n        \"git_url\": \"git://github.com/Codertocat/Hello-World.git\",\n        \"ssh_url\": \"git@github.com:Codertocat/Hello-World.git\",\n        \"clone_url\": \"https://github.com/Codertocat/Hello-World.git\",\n        \"svn_url\": \"https://github.com/Codertocat/Hello-World\",\n        \"homepage\": null,\n        \"size\": 0,\n        \"stargazers_count\": 0,\n        \"watchers_count\": 0,\n        \"language\": null,\n        \"has_issues\": true,\n        \"has_projects\": true,\n        \"has_downloads\": true,\n        \"has_wiki\": true,\n        \"has_pages\": true,\n        \"forks_count\": 0,\n        \"mirror_url\": null,\n        \"archived\": false,\n        \"open_issues_count\": 2,\n        \"license\": null,\n        \"forks\": 0,\n        \"open_issues\": 2,\n        \"watchers\": 0,\n        \"default_branch\": \"master\"\n      },\n      \"sender\": {\n        \"login\": \"Codertocat\",\n        \"id\": 21031067,\n        \"node_id\": \"MDQ6VXNlcjIxMDMxMDY3\",\n        \"avatar_url\": \"https://avatars1.githubusercontent.com/u/21031067?v=4\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/Codertocat\",\n        \"html_url\": \"https://github.com/Codertocat\",\n        \"followers_url\": \"https://api.github.com/users/Codertocat/followers\",\n        \"following_url\": \"https://api.github.com/users/Codertocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/Codertocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/Codertocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/Codertocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/Codertocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/Codertocat/repos\",\n        \"events_url\": \"https://api.github.com/users/Codertocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/Codertocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      }\n    }\n  ]\n}\n```\n\n## Download webhook definitions and webhook payloads schema\n\nYou can download the latest `index.json` and `schema.json` files from\n[unpkg](https://unpkg.com/)\n\n- [`index.json`](https://unpkg.com/@octokit/webhooks-examples/index.json)\n- [`schema.json`](https://unpkg.com/@octokit/webhooks-schemas/schema.json)\n\n## Usage as Node module\n\nTo get an array of all webhook definition objects, require the `@octokit/webhooks-examples` package.\n\n```js\n// Use Node.js require:\nconst WEBHOOKS = require(\"@octokit/webhooks-examples/index.json\");\n\n// Or ESM/TypeScript import:\nimport WEBHOOKS from \"@octokit/webhooks-examples/index.json\";\n```\n\nTo get the JSON schema for webhook payloads, require the `@octokit/webhooks-schemas` package.\n\n```js\n// Use Node.js require:\nconst SCHEMA = require(\"@octokit/webhooks-schemas\");\n\n// Or ESM/TypeScript import:\nimport SCHEMA from \"@octokit/webhooks-schemas\";\n```\n\n### Usage with `ajv` in `strict` mode\n\nWhen running in `strict` mode, `ajv` will throw an \"unknown keyword\" error if it\nencounters any keywords that have not been defined.\n\nThis schema currently uses custom keywords provided by `ajv-formats`, along with\nthe custom keyword `tsAdditionalProperties`.\n\nHere is an example of how you can set this up:\n\n```ts\nimport type { WebhookEvent } from \"@octokit/webhooks-types\";\nimport * as githubWebhookSchema from \"@octokit/webhooks-schemas\";\nimport Ajv from \"ajv\";\nimport addFormats from \"ajv-formats\";\n\nconst ajv = new Ajv({ strict: true });\n\naddFormats(ajv);\najv.addKeyword(\"tsAdditionalProperties\");\n\nconst validate = ajv.compile<WebhookEvent>(githubWebhookSchema);\n```\n\n## Importing types\n\nThis package ships with types for the webhook events generated from the\nrespective json schemas, which you can use like so:\n\n```typescript\nimport { WebhookEvent, IssuesOpenedEvent } from \"@octokit/webhooks-types\";\n\nconst handleWebhookEvent = (event: WebhookEvent) => {\n  if (\"action\" in event && event.action === \"completed\") {\n    console.log(`${event.sender.login} completed something!`);\n  }\n};\n\nconst handleIssuesOpenedEvent = (event: IssuesOpenedEvent) => {\n  console.log(\n    `${event.sender.login} opened \"${event.issue.title}\" on ${event.repository.full_name}`\n  );\n};\n```\n\n## How it works\n\nThis package updates itself using a daily cronjob running on GitHub Actions. The\n[`index.json`](index.json) file is generated by\n[`bin/octokit-webhooks.ts`](bin/octokit-webhooks.ts). Run\n`npm run octokit-webhooks -- --usage` for instructions. After the update is\ncomplete, run `npm run build:webhooks` and `npm run build:schema` to update\n`index.json` and `schema.json` files.\n\nThe update script is scraping\n[GitHub’s Webhooks Event Types & Payloads](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads)\ndocumentation page and extracts the meta information using\n[cheerio](https://www.npmjs.com/package/cheerio).\n\nFor simpler local testing and tracking of changes all loaded pages are cached in\nthe [`cache/`](cache/) folder.\n\n## See also\n\n- [octokit/graphql-schema](https://github.com/octokit/graphql-schema) – GitHub’s\n  GraphQL Schema with validation\n- [octokit/openapi](https://github.com/octokit/openapi) – GitHub REST API route\n  specifications\n- [octokit/app-permissions](https://github.com/octokit/app-permissions) – GitHub\n  App permission specifications\n\n## LICENSE\n\n[MIT](LICENSE.md)\n","gitHead":"58effce2bde6f13bacf9381beffa5fc4dbfedf59","license":"MIT","release":{"plugins":["@semantic-release/commit-analyzer","@semantic-release/release-notes-generator","@semantic-release/github","@semantic-release/npm",["semantic-release-plugin-update-version-in-files",{"files":["payload-*/package.json"],"placeholder":"0.0.0-development"}]],"branches":["master","beta"]},"scripts":{"lint":"prettier --check '{bin,lib}/*.ts' '*.{ts,md}' '{payload-examples,payload-schemas,payload-types}/**/*.md' '{payload-examples,payload-schemas}/**/*.json' 'payload-schemas/*.ts' 'payload-types/*.d.ts' *.md package.json","test":"npm run build && npm run build:schema && npm run validate -- --continue-on-error && ts-node -T test.ts","build":"ts-node -T bin/octokit-webhooks.ts check --cached","pretest":"npm run -s lint","lint:fix":"prettier --write '{bin,lib}/*.ts' '*.{ts,md}' '{payload-examples,payload-schemas,payload-types}/**/*.md' '{payload-examples,payload-schemas,payload-types}/**/*.json' 'payload-schemas/*.ts' 'payload-types/*.d.ts' *.md package.json","validate":"npm run -s validate:payloads && npm run -s validate:schema","build:all":"npm run -s build:webhooks && npm run -s build:schema && npm run -s build:types","typecheck":"tsc -p . --noEmit","build:types":"ts-node -T bin/octokit-types.ts","build:schema":"ts-node -T bin/octokit-schema.ts","build:webhooks":"ts-node -T bin/octokit-webhooks.ts update","octokit-schema":"ts-node -T bin/octokit-schema.ts","validate:schema":"ts-node -T bin/validate-schema.ts","octokit-webhooks":"ts-node -T bin/octokit-webhooks.ts","validate:payloads":"ts-node -T bin/validate-payload-examples.ts"},"_npmUser":{"name":"octokitbot","email":"octokitbot@martynus.net"},"homepage":"https://github.com/octokit/webhooks#readme","keywords":[],"prettier":{},"renovate":{"extends":["github>octokit/.github"]},"deprecated":"Use @octokit/webhooks-types, @octokit/webhooks-schemas, or @octokit/webhooks-examples instead. See https://github.com/octokit/webhooks/issues/447","repository":{"url":"git+https://github.com/octokit/webhooks.git","type":"git"},"_npmVersion":"7.9.0","description":"machine-readable, always up-to-date GitHub Webhooks specifications","directories":{},"maintainers":[{"name":"gr2m","email":"gregor@martynus.net"},{"name":"octokitbot","email":"octokitbot@martynus.net"}],"_nodeVersion":"12.22.1","dependencies":{},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"ajv":"^8.0.0","yargs":"^16.0.0","cheerio":"^1.0.0-rc.2","ts-node":"^9.1.1","prettier":"^2.0.5","turndown":"^7.0.0","json-diff":"^0.5.3","typescript":"^4.1.3","@types/node":"^14.14.20","ajv-formats":"^2.0.0","@types/yargs":"^16.0.0","@types/lodash":"^4.14.167","@types/cheerio":"^0.22.23","@types/prettier":"^2.1.6","@types/turndown":"^5.0.0","fast-deep-equal":"^3.1.3","@octokit/request":"^5.0.0","@types/json-diff":"^0.5.0","semantic-release":"^17.0.0","@types/json-schema":"^7.0.6","json-schema-to-typescript":"^10.1.2","prettier-plugin-packagejson":"^2.2.9","semantic-release-plugin-update-version-in-files":"^1.1.0"},"_npmOperationalInternal":{"tmp":"tmp/webhooks-definitions_3.68.0_1618666931622_0.46990090162064235","host":"s3://npm-registry-packages"},"_id":"@octokit/webhooks-definitions@3.68.0","version":"3.68.0"}