Skip to content

Document Rocket.Chat provider - #546

Open
mdiniz97 wants to merge 1 commit into
projectdiscovery:mainfrom
mdiniz97:docs/rocketchat-provider
Open

Document Rocket.Chat provider#546
mdiniz97 wants to merge 1 commit into
projectdiscovery:mainfrom
mdiniz97:docs/rocketchat-provider

Conversation

@mdiniz97

@mdiniz97 mdiniz97 commented Aug 1, 2026

Copy link
Copy Markdown

Summary

  • Documents the rocketchat provider in the README (features list, provider config example, webhook reference link)
  • Adds a rocketchat entry to the integration-test config, commented out in providers.go following the existing pattern for teams/telegram (no webhook secret configured in CI yet)

Depends on #545 for the provider implementation.

Summary by CodeRabbit

  • New Features

    • Added Rocket.Chat to the list of supported providers.
    • Added a Rocket.Chat configuration example and linked to incoming webhook documentation.
  • Documentation

    • Expanded provider setup guidance for Rocket.Chat.
    • Added placeholder integration notes for future Rocket.Chat support.

Adds Rocket.Chat to the provider config example and references in the
README, and wires a rocketchat entry into the integration-test
config/scaffolding (commented out, following the pattern used for
teams/telegram, since no webhook secret is configured in CI yet).
@coderabbitai

coderabbitai Bot commented Aug 1, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

The README adds Rocket.Chat to the supported providers, documents its configuration, and links to webhook setup instructions. The integration-test provider scaffold includes commented-out Rocket.Chat wiring.

Changes

Rocket.Chat support

Layer / File(s) Summary
Documentation and integration-test scaffold
README.md, cmd/integration-test/providers.go
The README lists Rocket.Chat, adds configuration fields and webhook documentation, and the integration-test file includes commented-out Rocket.Chat provider wiring.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Poem

A rabbit hops through webhook light,
Rocket.Chat joins the provider flight.
Config fields line up in a row,
While commented tests wait below.
“Thump, thump!” says Bun, “the docs now glow!”

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the primary change: documenting the Rocket.Chat provider.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 277: Update the Rocket.Chat Incoming Webhook link in the README to use
the current integrations-page section anchor, or remove the stale fragment while
preserving the existing destination.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: f58e9445-6c3c-4728-a279-498d7359880a

📥 Commits

Reviewing files that changed from the base of the PR and between 2d6ef20 and 81a7e2b.

⛔ Files ignored due to path filters (1)
  • cmd/integration-test/test-config.yaml is excluded by !**/*.yaml
📒 Files selected for processing (2)
  • README.md
  • cmd/integration-test/providers.go

Comment thread README.md
- [Creating Discord webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks)
- [Creating Telegram bot](https://core.telegram.org/bots#3-how-do-i-create-a-bot)
- [Creating Pushover Token](https://github.com/containrrr/shoutrrr/blob/main/docs/services/pushover.md)
- [Creating Rocket.Chat Incoming Webhook](https://docs.rocket.chat/docs/integrations#incoming-webhook-script)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Fix the stale fragment in the Rocket.Chat webhook reference.

The page resolves, but #incoming-webhook-script does not match a current section in the Rocket.Chat integrations page. Use the current section anchor or remove the fragment. (docs.rocket.chat)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 277, Update the Rocket.Chat Incoming Webhook link in the
README to use the current integrations-page section anchor, or remove the stale
fragment while preserving the existing destination.

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