{"repo":"octokit/webhooks","free":true,"listed":false,"github":"https://github.com/octokit/webhooks","clone":"git clone https://github.com/octokit/webhooks.git","description":"machine-readable, always up-to-date GitHub Webhooks specifications","language":"TypeScript","stars":260,"topics":["octokit-js","webhooks","specifications","generated","schema","hacktoberfest"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"Octokit Webhooks machine-readable, always up-to-date GitHub Webhooks specifications Download Download the latest specification at octokit.github.io/webhooks/payload-examples/api.github.com/index.json Example Example webhook definition Download webhook definitions and webhook payloads schema You can download the latest index.json and schema.json files from unpkg - index.json - schema.json Usage as Node module To get an array of all webhook definition objects, require the @octokit/webhooks-examples package. To get the JSON schema for webhook payloads, require the @octokit/webhooks-schemas package. Usage with ajv in strict mode When running in strict mode, ajv will throw an \"unknown keyword\" error if it encounters any keywords that have not been defined. This schema currently uses custom keywords provided by ajv-formats , along with the custom keyword tsAdditionalProperties . Here is an example of how you can set this up: Importing types This package ships with types for the webhook events generated from the respective json schemas, which you can use like so: ⚠️ Caution ⚠️ : Webhooks Types are expected to be used with the strictNullChecks option enabled in your tsconfig . If you don't have this option enabled, there's the possibility that you get never as the inferred type in some use cases. See #395 for details. How it works This package updates itself using a daily cronjob running on GitHub Actions. The index.json file is generated by bin/octokit-webhooks.mts . Run npm run oct","default_branch":null,"files":null,"tree":[],"storefront":"/r/octokit","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/octokit/webhooks/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}