Skip to content

Add type notice for burn_on_read webhook posts.#1500

Merged
svelle merged 2 commits intomasterfrom
svelle-patch-2
Mar 31, 2026
Merged

Add type notice for burn_on_read webhook posts.#1500
svelle merged 2 commits intomasterfrom
svelle-patch-2

Conversation

@svelle
Copy link
Copy Markdown
Member

@svelle svelle commented Mar 31, 2026

Updated the 'type' parameter description to clarify that it can be set to 'burn_on_read'.

Updated the 'type' parameter description to clarify that it can be set to 'burn_on_read'.
@github-actions
Copy link
Copy Markdown

Newest code from mattermost has been published to preview environment for Git SHA b546711

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 31, 2026

Warning

Rate limit exceeded

@svelle has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 15 minutes and 11 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 15 minutes and 11 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 91766b89-1b61-433e-a297-6463ef1262c9

📥 Commits

Reviewing files that changed from the base of the PR and between b546711 and 8750ecf.

📒 Files selected for processing (1)
  • site/content/integrate/webhooks/incoming/_index.md
📝 Walkthrough

Walkthrough

Updated the incoming webhook type parameter documentation to clarify that when not blank, it must start with custom_ unless explicitly set to burn_on_read. This refines the previous requirement specification for the parameter validation rule.

Changes

Cohort / File(s) Summary
Documentation
site/content/integrate/webhooks/incoming/_index.md
Clarified the type parameter requirement: must begin with custom_ when not blank, except when set to burn_on_read.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: adding a notice that the webhook type parameter can be set to burn_on_read, which directly matches the documentation update.
Description check ✅ Passed The description is directly related to the changeset, explaining that the 'type' parameter description was updated to clarify the burn_on_read option.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch svelle-patch-2

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
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the incoming webhook documentation to clarify that the type field can be set to the reserved value burn_on_read, in addition to the existing custom_-prefixed post types used primarily by plugins.

Changes:

  • Clarified the type parameter rules to allow burn_on_read as an exception to the custom_ prefix requirement.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread site/content/integrate/webhooks/incoming/_index.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@github-actions
Copy link
Copy Markdown

Newest code from mattermost has been published to preview environment for Git SHA 8750ecf

@svelle svelle requested review from esethna and wiersgallak March 31, 2026 13:42
@svelle svelle merged commit e5af74e into master Mar 31, 2026
6 checks passed
@svelle svelle deleted the svelle-patch-2 branch March 31, 2026 14:00
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.

3 participants