Skip to content

Conversation

capcom6
Copy link
Member

@capcom6 capcom6 commented Sep 25, 2025

Summary by CodeRabbit

  • Documentation
    • Added documentation for a new partsCount field on the sms:sent event in the supported events list.
    • Clarified multipart delivery behavior: when all parts are sent, partsCount reflects the total number of parts.
    • Updated multipart delivery tables for clarity and consistency, including minor wording and formatting refinements.
    • Confirmed no semantic changes to sms:received, sms:delivered, or sms:failed event descriptions; updates focus on clearer guidance and alignment across sections.

Copy link

coderabbitai bot commented Sep 25, 2025

Walkthrough

Documentation updates in docs/features/webhooks.md add a partsCount field to the sms:sent event and clarify multipart SMS delivery behavior, including when partsCount is populated. Minor wording and table formatting adjustments align descriptions without changing event semantics.

Changes

Cohort / File(s) Summary of Changes
Webhooks docs update
docs/features/webhooks.md
Added partsCount field to sms:sent in supported events; clarified multipart delivery behavior indicating partsCount equals number of parts when all are sent; reformatted tables and adjusted wording for consistency; no semantic changes to sms:received, sms:delivered, sms:failed.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title clearly summarizes the primary change, specifying the new partsCount field addition to the sms:sent payload in the webhooks documentation, which directly reflects the core update described in the pull request.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch features/webhooks-sent-parts-count

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bc5325a and bcff21f.

📒 Files selected for processing (1)
  • docs/features/webhooks.md (2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/features/webhooks.md

37-37: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)

@capcom6 capcom6 merged commit b58e644 into master Sep 29, 2025
2 checks passed
@capcom6 capcom6 deleted the features/webhooks-sent-parts-count branch September 29, 2025 12:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant