Skip to content

Document error status codes returned for interactive message integrations#1507

Open
sbishel wants to merge 1 commit into
masterfrom
preserve_plugin_retry_status
Open

Document error status codes returned for interactive message integrations#1507
sbishel wants to merge 1 commit into
masterfrom
preserve_plugin_retry_status

Conversation

@sbishel

@sbishel sbishel commented Jun 5, 2026

Copy link
Copy Markdown
Member

Summary

Updates the interactive messages docs to reflect that Mattermost now preserves certain upstream HTTP status codes (rather than always returning 400) when an integration backing a button or menu fails, so API clients can honor retry semantics.

Related PRs

mattermost/mattermost#36700

@github-actions

github-actions Bot commented Jun 5, 2026

Copy link
Copy Markdown

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

@coderabbitai

coderabbitai Bot commented Jun 5, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 772ea859-f77d-4d49-a39f-5806e8c72984

📥 Commits

Reviewing files that changed from the base of the PR and between 1ce44f1 and 48da468.

📒 Files selected for processing (1)
  • site/content/integrate/plugins/interactive-messages/_index.md

📝 Walkthrough

Walkthrough

This PR updates the interactive messages plugin documentation to clarify error handling behaviour. The "Error handling" section reference is revised to match updated FAQ phrasing, and the FAQ entry is expanded to explicitly document how Mattermost maps integration/connectivity errors and invalid responses to HTTP status codes returned to clients.

Changes

Interactive Message Error Handling Documentation

Layer / File(s) Summary
Error handling FAQ clarification
site/content/integrate/plugins/interactive-messages/_index.md
The "Error handling" section reference is updated to direct readers to the revised FAQ question, and the FAQ entry is expanded to document three failure scenarios (forbidden internal connections, upstream status codes, invalid JSON) and the corresponding HTTP response mappings (400, 429/503 preservation, 502/400 for 5xx/4xx).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: documenting how Mattermost now returns different error status codes for interactive message integrations instead of always returning 400.
Description check ✅ Passed The description is directly related to the changeset, explaining the motivation for the documentation update and referencing the related implementation PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ 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 preserve_plugin_retry_status

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.

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