{"repo":"octokit/webhooks.js","free":true,"listed":false,"github":"https://github.com/octokit/webhooks.js","clone":"git clone https://github.com/octokit/webhooks.js.git","description":"GitHub webhook events toolset for Node.js","language":"TypeScript","stars":349,"topics":["octokit-js","sdk","webhooks","hacktoberfest"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"@octokit/webhooks GitHub webhook events toolset for Node.js - Usage - Local development - API - Constructor - webhooks.sign() - webhooks.verify() - webhooks.verifyAndReceive() - webhooks.receive() - webhooks.on() - webhooks.onAny() - webhooks.onError() - webhooks.removeListener() - createNodeMiddleware() - Webhook events - emitterEventNames - validateEventName - TypeScript - EmitterWebhookEventName - EmitterWebhookEvent - License @octokit/webhooks helps to handle webhook events received from GitHub. GitHub webhooks can be registered in multiple ways 1. In repository or organization settings on github.com. 2. Using the REST API for repositories or organizations 3. By creating a GitHub App. Note that while setting a secret is optional on GitHub, it is required to be set in order to use @octokit/webhooks . Content Type must be set to application/json , application/x-www-form-urlencoded is not supported. Usage Local development You can receive webhooks on your local machine or even browser using EventSource and smee.io. Go to smee.io and Start a new channel . Then copy the \"Webhook Proxy URL\" and 1. enter it in the GitHub App’s \"Webhook URL\" input 2. pass it to the EventSource constructor, see below EventSource is a native browser API and can be polyfilled for browsers that don’t support it. In node, you can use the eventsource package: install with npm install eventsource , then import EventSource from \"eventsource\";) API 1. Constructor 1. webhooks.sign() 1. webhooks.verify() 1.","default_branch":null,"files":null,"tree":[],"storefront":"/r/octokit","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/octokit/webhooks.js/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."}