Skip to content

Clarify message attachment rendering in webhooks#1499

Merged
svelle merged 3 commits intomasterfrom
svelle-patch-1
Apr 1, 2026
Merged

Clarify message attachment rendering in webhooks#1499
svelle merged 3 commits intomasterfrom
svelle-patch-1

Conversation

@svelle
Copy link
Copy Markdown
Member

@svelle svelle commented Mar 31, 2026

Added a section explaining message attachment rendering requirements for webhooks.

Added a section explaining message attachment rendering requirements for webhooks.
@github-actions
Copy link
Copy Markdown

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

@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 20 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 20 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: 08aad16a-c40d-4cbb-802c-872914a9e2c8

📥 Commits

Reviewing files that changed from the base of the PR and between f601593 and 12714d6.

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

Walkthrough

Documentation update to the incoming webhooks guide that adds a troubleshooting section clarifying the required field placement for message attachments in webhook JSON payloads, contrasting the approach with REST API schema conventions.

Changes

Cohort / File(s) Summary
Webhook Documentation
site/content/integrate/webhooks/incoming/_index.md
Added troubleshooting guidance specifying that attachments must be a top-level field in incoming webhook JSON, not nested within props, with clarification on the schema difference from REST API conventions.

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: clarifying webhook message attachment rendering requirements, which directly matches the additions to the documentation.
Description check ✅ Passed The description is related to the changeset, providing a brief explanation that aligns with the added troubleshooting section about attachment rendering requirements.
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-1

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 clarifies incoming webhook behavior for rendering message attachments by documenting that attachments must be provided as a top-level JSON field (not nested under props), aligning expectations between incoming webhooks and the REST API payload shape.

Changes:

  • Added a troubleshooting subsection explaining why message attachments may not render.
  • Documented the required placement of attachments as a top-level field for incoming webhooks.

💡 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 12714d6

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.


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

@svelle svelle requested a review from esethna March 31, 2026 13:39
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 1, 2026

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

@svelle svelle merged commit aae6c3a into master Apr 1, 2026
4 checks passed
@svelle svelle deleted the svelle-patch-1 branch April 1, 2026 08:59
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