[RealtimeKit] add documentation for webhooks#31203
Open
ToxicityMax wants to merge 9 commits into
Open
Conversation
ToxicityMax
requested review from
a team,
ravindra-cloudflare and
roerohan
as code owners
Review⏸️ Automatic reviews for this PR are paused. This PR has already received 2 automatic reviews. To run another review, a codeowner can comment
✅ No style-guide issues found in commit CommandsOnly codeowners can run commands. Post a comment with the command to trigger it.
|
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
ask-bonk
Bot
changed the title
ask-bonk
Bot
added
documentation
![ask-bonk[bot]](https://avatars.githubusercontent.com/in/2454580?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
4 issues need fixing before merge. Posted 6 inline suggestions and 2 comments.
MEDIUM
src/content/docs/realtime/realtimekit/webhooks.mdx:17-21— Procedure must use<Steps>.src/content/docs/realtime/realtimekit/webhooks.mdx:29— Workers example must use<TypeScriptExample>.src/content/docs/realtime/realtimekit/webhooks.mdx:123— Workers example must use<TypeScriptExample>.
LOW
src/content/docs/realtime/realtimekit/webhooks.mdx:65— curl blocks must use$VARIABLE_NAMEplaceholders.src/content/docs/realtime/realtimekit/webhooks.mdx:224— curl blocks must use$VARIABLE_NAMEplaceholders.src/content/docs/realtime/realtimekit/recording-guide/monitor-status.mdx:32— curl blocks must use$VARIABLE_NAMEplaceholders.
Consider adding a changelog entry for the new webhooks page.
|
|
||
| Your webhook endpoint must accept JSON `POST` requests. The endpoint can handle multiple event types by switching on the `event` field in the request body. | ||
|
|
||
| ```javascript |
Contributor
There was a problem hiding this comment.
Workers examples must use <TypeScriptExample>, not bare javascript fences. Convert this example to TypeScript and wrap it with the component.
|
|
||
| Verify `rtk-signature` against the raw request body. Do not reserialize parsed JSON before verification because changes in whitespace or key order can change the signed bytes. | ||
|
|
||
| ```javascript |
Contributor
There was a problem hiding this comment.
Workers examples must use <TypeScriptExample>, not bare javascript fences. Convert this example to TypeScript and wrap it with the component.
Contributor
|
Review completed for PR #31203. What the PR changes
Actions taken
Issues flagged
|
Contributor
Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>
Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>
Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>
Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>
Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>
Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>
…status.mdx Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>
…status.mdx Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>
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
3 participants
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.
Summary
Add documentation for realtimekit webhooks
Screenshots (optional)
Documentation checklist