[features] webhooks UI docs entry #90
Conversation
WalkthroughThe webhooks documentation was reformatted into a concise, icon-enhanced grid layout, simplifying event descriptions and removing redundant details. Verification of webhook registration now includes both an API Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant SMS Gateway App
participant API
User->>API: Verify webhook registration via curl command
API-->>User: Return verification status
User->>SMS Gateway App: Navigate to Settings > Webhooks > Registered webhooks
SMS Gateway App-->>User: Display list of registered webhooks with details
Possibly related PRs
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Note ⚡️ Faster reviews with cachingCodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/features/webhooks.md (2)
131-131: Remove trailing punctuation and use raw emoji in heading.The heading currently ends with a colon (MD026) and uses a shortcode (
:material-eye:) instead of a unicode emoji, which is inconsistent with other sections. Consider updating it to:-### Registered Webhooks :material-eye: +### Registered Webhooks 👁️🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
131-131: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
129-130: Add a brief introduction under the new section.Before diving into the steps, a one-line overview helps orient readers. For example:
## Webhooks Management 🔍 + +Use the following steps to view and manage your registered webhooks in the SMS Gateway app.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/features/webhooks.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/features/webhooks.md
131-131: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Cloudflare Pages
docs/features/webhooks.md
Outdated
| <figure markdown> | ||
| { align=center } | ||
| <figcaption>Webhooks management interface</figcaption> | ||
| </figure> | ||
|
|
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify that the referenced screenshot asset exists.
Ensure the image at docs/assets/webhooks-list.png is present and up-to-date to prevent broken links in the docs.
🏁 Script executed:
#!/bin/bash
# Verify the screenshot asset exists
test -f docs/assets/webhooks-list.png || {
echo "Error: docs/assets/webhooks-list.png not found"
exit 1
}Length of output: 151
🏁 Script executed:
#!/bin/bash
# List contents of the docs/assets directory
echo "docs/assets contents:"
ls docs/assets
# Search the entire repository for any occurrence of webhooks-list.png
echo "Searching for webhooks-list.png in repo:"
find . -type f -name "webhooks-list.png"Length of output: 425
Asset Missing: webhooks-list.png
The docs at docs/features/webhooks.md reference ../assets/webhooks-list.png, but this file does not exist in docs/assets/. Please add the correct screenshot file to docs/assets/ or update the reference to match an existing asset to prevent a broken image link.
Files to update:
- docs/features/webhooks.md (lines 143–147) – fix the
path. - docs/assets/ – add the missing
webhooks-list.pngscreenshot or rename an existing file accordingly.
🤖 Prompt for AI Agents (early access)
In docs/features/webhooks.md around lines 143 to 147, the image reference to
../assets/webhooks-list.png is broken because the file does not exist in
docs/assets/. To fix this, either add the missing webhooks-list.png screenshot
file to the docs/assets/ directory or update the image path in the markdown to
point to an existing image file in docs/assets/ that represents the webhooks
list interface.
Deploying docs with
|
| Latest commit: |
a09f741
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://a8ad4369.docs-7wm.pages.dev |
| Branch Preview URL: | https://features-webhooks-ui.docs-7wm.pages.dev |
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/features/webhooks.md (1)
100-101: Asset Missing:webhooks-list.png
The docs reference../assets/webhooks-list.png, but this file is not present indocs/assets/. Please add the missing screenshot or update the path to an existing asset to prevent broken image links.
🧹 Nitpick comments (2)
docs/features/webhooks.md (2)
7-34: Use native Markdown grid container instead of raw HTML for event cards
The<div class="grid cards" markdown>block bypasses MkDocs Material’s built-in grid syntax, making the markup harder to read and maintain. Consider using the::: gridand::: cardcontainers to define each event card in pure Markdown. This also avoids markdownlint MD007 errors inside an HTML block. For example:- <div class="grid cards" markdown> - - :incoming_envelope: **sms:received** - - `messageId`: Content-based ID - - `message`: SMS content - … - </div> + ::: grid + ::: card "📩 sms:received" + `messageId`: Content-based ID + `message`: SMS content + `phoneNumber`: Sender’s number + `simNumber`: SIM index (nullable) + `receivedAt`: Local timestamp + ::: + + ::: card "📤 sms:sent" + … + ::: + ::: card "✔️ sms:delivered" + … + ::: + ::: card "❌ sms:failed" + … + ::: + ::: card "🏓 system:ping" + `health`: [Healthcheck status](./health.md) + ::: + :::🧰 Tools
🪛 LanguageTool
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...?- 📨 sms:received ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ... -receivedAt: Local timestamp - 📤 sms:sent - `message...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~22-~22: Loose punctuation mark.
Context: ...e) -sentAt: Local timestamp - ✅ sms:delivered ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~31-~31: Loose punctuation mark.
Context: ... -failedAt: Local timestamp - 🏓 system:ping - `health...(UNLIKELY_OPENING_PUNCTUATION)
🪛 markdownlint-cli2 (0.17.2)
10-10: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
11-11: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
12-12: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
13-13: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
14-14: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
17-17: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
18-18: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
19-19: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
20-20: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
23-23: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
25-25: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
32-32: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
90-99: Unify admonition syntax and replace deprecated<center>tag
Similarly, convert the app interface section to a MkDocs admonition and center the screenshot using a<div align="center">(the<center>tag is deprecated):- === "Via App Interface :material-cellphone:" + !!! info "Via App Interface" :material-cellphone: 1. Open the SMS Gateway app 📱 2. Navigate to **Settings** > **Webhooks** > **Registered webhooks** … - <center> -  - </center> + <div align="center"> +  + </div>🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
92-92: Code block style
Expected: fenced; Actual: indented(MD046, code-block-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
docs/assets/webhooks-list.pngis excluded by!**/*.png
📒 Files selected for processing (1)
docs/features/webhooks.md(4 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/features/webhooks.md
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...?
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ... - receivedAt: Local timestamp - 📤 sms:sent - `message...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~22-~22: Loose punctuation mark.
Context: ...e) - sentAt: Local timestamp - ✅ sms:delivered ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~31-~31: Loose punctuation mark.
Context: ... - failedAt: Local timestamp - 🏓 system:ping - `health...
(UNLIKELY_OPENING_PUNCTUATION)
🪛 markdownlint-cli2 (0.17.2)
docs/features/webhooks.md
10-10: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
11-11: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
12-12: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
13-13: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
14-14: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
17-17: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
18-18: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
19-19: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
20-20: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
23-23: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
25-25: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
32-32: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
83-83: Code block style
Expected: fenced; Actual: indented
(MD046, code-block-style)
92-92: Code block style
Expected: fenced; Actual: indented
(MD046, code-block-style)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Cloudflare Pages
| === "Via API Method :material-api:" | ||
|
|
||
| ```sh title="Cloud mode example" | ||
| curl -X GET -u <username>:<password> \ | ||
| https://api.sms-gate.app/3rdparty/v1/webhooks | ||
| ``` | ||
| You can verify that it has been successfully registered by executing the following `curl` command: | ||
|
|
||
| ```sh title="Cloud mode example" | ||
| curl -X GET -u <username>:<password> \ | ||
| https://api.sms-gate.app/3rdparty/v1/webhooks | ||
| ``` | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Unify admonition syntax for API verification
The === "Via API Method :material-api:" syntax mixes Docusaurus-style containers into an MkDocs Material documentation set. Replace with a native MkDocs Material info admonition:
- === "Via API Method :material-api:"
+ !!! info "Via API Method" :material-api:📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| === "Via API Method :material-api:" | |
| ```sh title="Cloud mode example" | |
| curl -X GET -u <username>:<password> \ | |
| https://api.sms-gate.app/3rdparty/v1/webhooks | |
| ``` | |
| You can verify that it has been successfully registered by executing the following `curl` command: | |
| ```sh title="Cloud mode example" | |
| curl -X GET -u <username>:<password> \ | |
| https://api.sms-gate.app/3rdparty/v1/webhooks | |
| ``` | |
| !!! info "Via API Method" :material-api: | |
| You can verify that it has been successfully registered by executing the following `curl` command: |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
83-83: Code block style
Expected: fenced; Actual: indented
(MD046, code-block-style)
🤖 Prompt for AI Agents (early access)
In docs/features/webhooks.md around lines 81 to 89, replace the Docusaurus-style
container syntax `=== "Via API Method :material-api:"` with the native MkDocs
Material info admonition syntax by using `::: info` to start the block and `:::`
to end it, ensuring consistent documentation style.
capcom6
force-pushed
the
features/webhooks-ui
branch
from
9ed5f15 to
a09f741
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
docs/features/webhooks.md (2)
81-89: Use native MkDocs Material admonition syntax
The=== "Via API Method :material-api:"block uses Docusaurus-style syntax, which isn’t supported by MkDocs Material. Replace it with a fenced admonition for consistency:- === "Via API Method :material-api:" + !!! info "Via API Method" :material-api:🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
83-83: Code block style
Expected: fenced; Actual: indented(MD046, code-block-style)
90-102: Use native MkDocs Material admonition for app interface
Similarly, convert the Docusaurus-style block:- === "Via App Interface :material-cellphone:" + !!! info "Via App Interface" :material-cellphone:This ensures uniform styling and compatibility with MkDocs Material.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
92-92: Code block style
Expected: fenced; Actual: indented(MD046, code-block-style)
🧹 Nitpick comments (2)
docs/features/webhooks.md (2)
7-8: Verify grid cards layout support and formatting
You’ve wrapped the events list in a<div class="grid cards" markdown>container. Ensure this renders correctly under the MkDocs Material theme—preview the page, and confirm there are blank lines immediately before and after the<div>for proper Markdown parsing.
151-152: Clarify periodic review frequency
You’ve added a recommendation to “Review Registered Webhooks Periodically.” Consider specifying a suggested interval (e.g., monthly) or linking to a guideline so users know how often to perform this check.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
docs/assets/webhooks-list.pngis excluded by!**/*.png
📒 Files selected for processing (1)
docs/features/webhooks.md(4 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/features/webhooks.md
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...?
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ... - receivedAt: Local timestamp - 📤 sms:sent - `message...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~22-~22: Loose punctuation mark.
Context: ...e) - sentAt: Local timestamp - ✅ sms:delivered ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~31-~31: Loose punctuation mark.
Context: ... - failedAt: Local timestamp - 🏓 system:ping - `health...
(UNLIKELY_OPENING_PUNCTUATION)
🪛 markdownlint-cli2 (0.17.2)
docs/features/webhooks.md
10-10: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
11-11: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
12-12: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
13-13: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
14-14: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
17-17: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
18-18: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
19-19: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
20-20: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
23-23: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
25-25: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
32-32: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
83-83: Code block style
Expected: fenced; Actual: indented
(MD046, code-block-style)
92-92: Code block style
Expected: fenced; Actual: indented
(MD046, code-block-style)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Cloudflare Pages
🔇 Additional comments (1)
docs/features/webhooks.md (1)
100-100:✅ Verification successful
Ensure referenced screenshot asset exists
The image linkpoints todocs/assets/webhooks-list.png. Verify that the file is included in this PR. If it’s missing, add the screenshot or update the path to a valid asset to prevent a broken image.
🏁 Script executed:
#!/bin/bash # Search for the referenced screenshot asset in the docs directory echo "Looking for webhooks-list.png under docs..." find docs -type f -name 'webhooks-list.png'Length of output: 170
Asset exists: no action needed
Verified thatdocs/assets/webhooks-list.pngis present in the PR. The image link is valid.
Summary by CodeRabbit