Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: v9 #518

Closed
wants to merge 11 commits into from
Closed

feat: v9 #518

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
b030f66
fix: remove deprecated `createWebhooksApi()`
gr2m Mar 30, 2021
fc9dc31
fix: remove deprecated `webhooks.middleware` and undocumented `create…
gr2m Mar 30, 2021
278a71f
fix: remove deprecated `path` option for `Webhooks` constructor
gr2m Mar 30, 2021
eede0fb
fix: remove `debug`
gr2m Mar 30, 2021
3caaaf5
feat: default `sign` algorithm to `sha256`
gr2m Mar 30, 2021
b2fbbb5
fix: use `options.onUnhandledRequest` in `createNodeMiddleware(webhoo…
gr2m Mar 30, 2021
3850ed6
docs(sign): show a sha256 signature as example
gr2m Apr 10, 2021
f0e5ecd
feat: browser compatibility
gr2m Apr 10, 2021
38345f8
build: add web build to pika pipeline
gr2m Apr 11, 2021
662f35c
fix: testing deno compatibility be removing import from `"http"`
gr2m Apr 11, 2021
ed654b7
docs(README): fix usage example
gr2m Apr 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ webhooks.sign(eventPayload);

Returns a `signature` string. Throws error if `eventPayload` is not passed.

Can also be used [standalone](src/sign/).
The `sign` method can be imported as static method from [`@octokit/webhooks-methods`](https://github.com/octokit/webhooks-methods.js/#readme).

### webhooks.verify()

Expand Down Expand Up @@ -216,7 +216,7 @@ webhooks.verify(eventPayload, signature);

Returns `true` or `false`. Throws error if `eventPayload` or `signature` not passed.

Can also be used [standalone](src/verify/).
The `verify` method can be imported as static method from [`@octokit/webhooks-methods`](https://github.com/octokit/webhooks-methods.js/#readme).

### webhooks.verifyAndReceive()

Expand Down Expand Up @@ -306,7 +306,7 @@ eventHandler
id: request.headers["x-github-delivery"],
name: request.headers["x-github-event"],
payload: request.body,
signature: request.headers["x-hub-signature"],
signature: request.headers["x-hub-signature-256"],
})
.catch(handleErrorsFromHooks);
```
Expand Down
Loading