Skip to content

Minor change for cloud since release of webhooks#3521

Open
gillian-meilisearch wants to merge 1 commit intomainfrom
webhook-doc-update
Open

Minor change for cloud since release of webhooks#3521
gillian-meilisearch wants to merge 1 commit intomainfrom
webhook-doc-update

Conversation

@gillian-meilisearch
Copy link
Copy Markdown
Contributor

@gillian-meilisearch gillian-meilisearch commented Mar 23, 2026

Description

The ability to add, update and delete webhooks has been added to Meilisearch Cloud today. This doc change points to where this can be done in the Cloud

Checklist

For internal Meilisearch team member only:

For external maintainers

  • Did you use any AI tool while implementing this PR (code, tests, docs, etc.)? If yes, disclose it in the PR description and describe what it was used for. AI usage is allowed when it is disclosed.
  • Have you made sure that the title is accurate and descriptive of the changes?

Summary by CodeRabbit

  • Documentation
    • Updated webhook configuration guidance to clarify that Meilisearch Cloud users can configure webhooks through Project Settings > Webhooks.
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 23, 2026

📝 Walkthrough

Walkthrough

Updated webhook configuration guidance in documentation by replacing the recommendation to use the /webhooks API route with instructions to configure webhooks via Project Settings in Meilisearch Cloud.

Changes

Cohort / File(s) Summary
Documentation
resources/self_hosting/webhooks.mdx
Updated Tip callout to redirect webhook configuration guidance from /webhooks API route to Meilisearch Cloud's Project Settings > Webhooks interface.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A webhook guide once pointed the way,
Through API routes old and worn gray,
Now clouds hold the settings so bright,
Where Project controls make things right! 🌩️

🚥 Pre-merge checks | ✅ 3
✅ 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 references webhook configuration updates in response to cloud webhook feature release, which aligns with the changeset that updates documentation to redirect webhook configuration guidance for Meilisearch Cloud.
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 webhook-doc-update

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

Copy link
Copy Markdown

@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.

🧹 Nitpick comments (1)
resources/self_hosting/webhooks.mdx (1)

13-13: Add a direct link to the Cloud Webhooks settings page for discoverability.

This update is clear, but users cannot click through from this page. Please link Project Settings > Webhooks to the relevant Meilisearch Cloud docs/settings page.

As per coding guidelines, "When adding or moving content, update or add links from related pages so users can find it."

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@resources/self_hosting/webhooks.mdx` at line 13, Replace the plain text "Project Settings > Webhooks" with a clickable link to the Meilisearch Cloud Webhooks settings/docs page (use the canonical URL for Meilisearch Cloud Webhooks), e.g., update the string in resources/self_hosting/webhooks.mdx so the phrase "Project Settings > Webhooks" becomes a Markdown/MDX anchor to the Cloud Webhooks settings/docs; ensure the link opens the correct Meilisearch Cloud page and follow existing link style used elsewhere in the repo for consistency. 
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed. Nitpick comments: In `@resources/self_hosting/webhooks.mdx`: - Line 13: Replace the plain text "Project Settings > Webhooks" with a clickable link to the Meilisearch Cloud Webhooks settings/docs page (use the canonical URL for Meilisearch Cloud Webhooks), e.g., update the string in resources/self_hosting/webhooks.mdx so the phrase "Project Settings > Webhooks" becomes a Markdown/MDX anchor to the Cloud Webhooks settings/docs; ensure the link opens the correct Meilisearch Cloud page and follow existing link style used elsewhere in the repo for consistency. 

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: cae7ee66-54cd-4bb1-bc21-3e8243b7cbc4

📥 Commits

Reviewing files that changed from the base of the PR and between 0148438 and e786140.

📒 Files selected for processing (1)
  • resources/self_hosting/webhooks.mdx
@mintlify
Copy link
Copy Markdown

mintlify bot commented Mar 23, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
meilisearch-documentation 🟢 Ready View Preview Mar 23, 2026, 4:48 PM
This guide teaches you how to configure a single webhook via instance options to notify a URL when Meilisearch completes a [task](/learn/async/asynchronous_operations).

<Tip>
If you are using Meilisearch Cloud or need to configure multiple webhooks, use the [`/webhooks` API route](/reference/api/webhooks) instead.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I thought we could keep the "use the /webhooks API route" in addition to "you can configure webhooks under Project Settings > Webhooks" to make it explicit that both are now possible for Cloud users (except if there's some other limitation on the Cloud?).

@qdequele
Copy link
Copy Markdown
Member

I do think that with the new architecture, I would prefer to create a new capability named Platform, where we list most of the advantages of the cloud and all the management of the Meilisearch platform. Such as resources (architecture, region, upgrade, monitoring, dumps), webhooks, teams (bring back), billing, and sharding.

This way we would have a clear separation and we would keep the self-hosting section only for the the people that want to self-host without mentioning the cloud 2 sentences. I will also allow us to have better presentation of those capabilities.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

3 participants