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

Jump to bottom

Update info on how to process webhooks by disabling bodyParser #33909

Merged
merged 5 commits into from Feb 2, 2022
Merged

Update info on how to process webhooks by disabling bodyParser #33909

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ecce861
Add information on how to process webhooks and disable bodyParser
amandeepmittal Feb 2, 2022
9d5ad0a
Update info about disabling body parser for a webhook request
amandeepmittal Feb 2, 2022
2b952c4
Update docs/api-routes/api-middlewares.md
amandeepmittal Feb 2, 2022
04437d4
Update docs/api-routes/api-middlewares.md
amandeepmittal Feb 2, 2022
27c3cd1
Merge branch 'canary' into process-webhooks
kodiakhq[bot] Feb 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/api-routes/api-middlewares.md
View file
Open in desktop
Expand Up @@ -34,7 +34,9 @@ export const config = {

The `api` object includes all configs available for API routes.

`bodyParser` Enables body parsing, you can disable it if you want to consume it as a `Stream`:
`bodyParser` is automatically enabled. If you want to consume the body as a `Stream` or with [`raw-body`](https://www.npmjs.com/package/raw-body), you can set this to `false`.

One use case for disabling the automatic `bodyParsing` is to allow you to verify the raw body of a **webhook** request, for example [from GitHub](https://docs.github.com/en/developers/webhooks-and-events/webhooks/securing-your-webhooks#validating-payloads-from-github).

```js
export const config = {
Expand Down