Add webhook handling cookbook recipe#473
Open
samdark wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new English cookbook recipe explaining how to safely handle incoming third-party webhooks in a Yii3 application, and wires the new page into the cookbook index and the VitePress sidebar so it appears in navigation.
Changes:
- New
src/cookbook/handling-webhooks.mdrecipe covering POST-only routing, CSRF exclusion guidance, raw-body HMAC signature verification with timestamp freshness checks, delivery-ID idempotency, and retry-aware response codes (2xx/400/401/5xx/202). - Adds
IncomingWebhookAction,ProcessedWebhookRepositoryandWebhookProcessorexample code plus a DI config snippet wiringWEBHOOK_SECRETinto the action. - Inserts navigation entries for the new recipe in the English cookbook index and the VitePress sidebar (between "Making HTTP Requests" and "Using htmx for Partial Page Reloads").
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/cookbook/handling-webhooks.md | New cookbook recipe with route, action, repository/processor interfaces, DI snippet, response-code guidance, and operational checklist. |
| src/cookbook/index.md | Adds a link to the new recipe in the English cookbook index. |
| src/.vitepress/config.js | Adds the matching sidebar entry for the new recipe. |
Comment on lines
+163
to
+169
| return [ | ||
| IncomingWebhookAction::class => [ | ||
| '__construct()' => [ | ||
| 'webhookSecret' => $_ENV['WEBHOOK_SECRET'], | ||
| ], | ||
| ], | ||
| ]; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a cookbook article for handling incoming third-party POST requests and webhooks, including raw-body signature verification, timestamp checks, idempotency, retry-aware response codes, and cookbook navigation entries.
Verification: