Skip to content

Docs: make the webhook event links reach the payloads they promise - #620

Open
amitthacker-maker wants to merge 1 commit into
cometchat:mainfrom
amitthacker-maker:docs/webhook-event-anchors
Open

amitthacker-maker wants to merge 1 commit into
cometchat:mainfrom
amitthacker-maker:docs/webhook-event-anchors

Conversation

@amitthacker-maker

Copy link
Copy Markdown

The problem

Ninety-six links about webhook payloads lead nowhere. Checked live on 2026-11-18.

The overview page points at the wrong page. fundamentals/webhooks-overview lists 50 webhook events and tells the reader: "Click each event name to see its payload and details." All 50 names link to /fundamentals/webhooks#<event>. That page has six category headings and no per-event anchor, and it carries no payloads at all, so every click lands at the top of the wrong page.

The right page's own links are dead too, for a different reason. The payloads are in the webhook API reference, one heading and one JSON block per event, and its trigger table links to them with 46 same-page #<event> links. The event headings are h5, and h5 headings are not given an id. The served HTML for that page has ids for the h4 category headings (groups, messages, users, moderation, campaigns) and not one id containing an underscore. So those 46 links do nothing either.

Net effect: there is no working link to a webhook payload anywhere in the documentation, on either page that offers one.

The fix

Change Where Count
Add an anchor before each event heading webhook API reference 47
Repoint an event link to that anchor Fundamentals overview 45
Leave the name unlinked, no payload exists Fundamentals overview 5
Reword the sentence above the tables Fundamentals overview 1

The anchors use the <a id="..." /> form already used in insights.mdx, which is confirmed to render on the published site. Adding them repairs the reference page's own 46 links as a side effect.

No payload text, event name or description is changed.

Five events have no payload documented anywhere

group_member_removed, call_busy, call_cancelled, call_rejected, call_unanswered.

Their names are now plain text and the page says why. Four of the five are call outcomes, which is what an integrator most often needs to handle, so they are worth documenting.

Two things for someone who owns this content

Both are left out of this change on purpose, because they are about what the pages should say rather than where a link goes.

  1. The two event lists disagree. Six events appear in the Fundamentals overview but not in the reference's supported-trigger table: the five above plus user_mentioned. Two appear in the reference's table but not in the overview: moderation_engine_failed and transcription_generated.
  2. user_mentioned has a payload section in the reference but is missing from that page's own trigger table.

🤖 Generated with Claude Code

Ninety-six links about webhook payloads led nowhere. Checked live on
2026-11-18.

The webhooks overview under Fundamentals lists 50 events and tells the
reader to click an event name to see its payload. All 50 names linked to
/fundamentals/webhooks#<event>. That page has six category headings and no
per-event anchor, so every one of them landed at the top of a page that
carries no payloads at all.

The payloads live in the webhook API reference, one heading and one JSON
block per event. That page's own 46 event links were dead too, for a
different reason: the event headings are h5, and h5 headings are not given
an id, so no anchor existed to jump to. The served HTML has ids for the
category headings and none containing an underscore.

So:

- Add an anchor before each of the 47 event headings in the reference,
  in the form insights.mdx already uses and which is confirmed to render.
  This repairs the reference page's own 46 links as well.
- Repoint the 45 overview links that have a payload to that anchor.
- Leave the other five as plain names, because no payload is documented
  for them anywhere: group_member_removed, call_busy, call_cancelled,
  call_rejected and call_unanswered. The overview now says so rather than
  offering a link that goes nowhere.
- Reword the sentence above the tables so it describes what the links
  now do.

No payload text, event name or description is changed.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Nov 18, 2026

Copy link
Copy Markdown

Preview approval required

This pull request comes from a fork, so Mintlify won't build a preview until someone with write access approves commit c3979e8.

Approve preview

This branch has not been deployed

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

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants