\n secret\n (String)\n | \n \n Required.\n Secret as configured in GitHub Settings.\n | \n
\n transform\n (Function)\n | \n \n Only relevant for webhooks.on.\n Transform emitted event before calling handlers. Can be asynchronous.\n | \n
\n log\n \n object\n \n | \n \n\nUsed for internal logging. Defaults to [`console`](https://developer.mozilla.org/en-US/docs/Web/API/console) with `debug` and `info` doing nothing.\n\n | \n
\n eventPayload\n \n (String)\n \n | \n \n Required.\n Webhook request payload as received from GitHub\n | \n
\n eventPayload\n \n (String)\n \n | \n \n Required.\n Webhook event request payload as received from GitHub.\n | \n
\n signature\n \n (String)\n \n | \n \n Required.\n Signature string as calculated by webhooks.sign().\n | \n
\n id\n \n String\n \n | \n \n Unique webhook event request id\n | \n
\n name\n \n String\n \n | \n \n Required.\n Name of the event. (Event names are set as X-GitHub-Event header\n in the webhook event request.)\n | \n
\n payload\n \n String\n \n | \n \n Required.\n Webhook event request payload as received from GitHub.\n | \n
\n signature\n \n (String)\n \n | \n \n Required.\n Signature string as calculated by webhooks.sign().\n | \n
\n id\n \n String\n \n | \n \n Unique webhook event request id\n | \n
\n name\n \n String\n \n | \n \n Required.\n Name of the event. (Event names are set as X-GitHub-Event header\n in the webhook event request.)\n | \n
\n payload\n \n Object\n \n | \n \n Required.\n Webhook event request payload as received from GitHub.\n | \n
\n eventName\n \n String\n \n | \n \n Required.\n Name of the event. One of GitHub's supported event names, or (if the event has an action property) the name of an event followed by its action in the form of <event>.<action>.\n | \n
\n eventNames\n \n Array\n \n | \n \n Required.\n Array of event names.\n | \n
\n handler\n \n Function\n \n | \n \n Required.\n Method to be run each time the event with the passed name is received.\n the handler function can be an async function, throw an error or\n return a Promise. The handler is called with an event object: {id, name, payload}.\n | \n
\n handler\n \n Function\n \n | \n \n Required.\n Method to be run each time any event is received.\n the handler function can be an async function, throw an error or\n return a Promise. The handler is called with an event object: {id, name, payload}.\n | \n
\n handler\n \n Function\n \n | \n \n Required.\n Method to be run each time a webhook event handler throws an error or returns a promise that rejects.\n The handler function can be an async function,\n return a Promise. The handler is called with an error object that has a .event property which has all the information on the event: {id, name, payload}.\n | \n
\n eventName\n \n String\n \n | \n \n Required.\n Name of the event. One of GitHub's supported event names, or (if the event has an action property) the name of an event followed by its action in the form of <event>.<action>, or '*' for the onAny() method or 'error' for the onError() method.\n | \n
\n eventNames\n \n Array\n \n | \n \n Required.\n Array of event names.\n | \n
\n handler\n \n Function\n \n | \n \n Required.\n Method which was previously passed to webhooks.on(). If the same handler was registered multiple times for the same event, only the most recent handler gets removed.\n | \n
\n webhooks\n \n Webhooks instance\n \n | \n \n Required.\n | \n
\n path\n \n string\n \n | \n \n Custom path to match requests against. Defaults to /api/github/webhooks.\n | \n
\n log\n \n object\n \n | \n \n\nUsed for internal logging. Defaults to [`console`](https://developer.mozilla.org/en-US/docs/Web/API/console) with `debug` and `info` doing nothing.\n\n | \n
\n webhooks\n \n Webhooks instance\n \n | \n \n Required.\n | \n
\n path\n \n string\n \n | \n \n Custom path to match requests against. Defaults to /api/github/webhooks.\n | \n
\n log\n \n object\n \n | \n \n\nUsed for internal logging. Defaults to [`console`](https://developer.mozilla.org/en-US/docs/Web/API/console) with `debug` and `info` doing nothing.\n\n | \n