Skip to content

Docs.json webhooks template#191

Merged
jklein24 merged 2 commits intomainfrom
cursor/docs-json-webhooks-template-e166
Feb 13, 2026
Merged

Docs.json webhooks template#191
jklein24 merged 2 commits intomainfrom
cursor/docs-json-webhooks-template-e166

Conversation

@pengying
Copy link
Contributor

Add webhooks documentation to the API Reference tab to improve accessibility and consistency.

This change addresses feedback that webhook information should be more accessible within the API reference section, aligning it with other key API topics.


Slack Thread

Open in Cursor Open in Web

- Created api-reference/webhooks.mdx using the shared webhooks snippet
- Added webhooks page to the 'Using the API' group in docs.json
- Addresses feedback that webhook info should be in API reference section

Co-authored-by: Peng Ying <pengying@users.noreply.github.com>
@cursor
Copy link

cursor bot commented Feb 12, 2026

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
Learn more about Cursor Agents

- Added bell.svg icon to match other api-reference pages
- Added og:image for consistent social sharing

Co-authored-by: Peng Ying <pengying@users.noreply.github.com>
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Feb 13, 2026

Greptile Overview

Greptile Summary

Added webhooks documentation to the API Reference tab to improve accessibility and consistency across the documentation.

Key changes:

  • Created new api-reference/webhooks.mdx page that imports the shared webhooks.mdx snippet (consistent with webhook pages in other use-case tabs)
  • Added page to docs.json navigation under "Using the API" group, positioned after authentication
  • Includes proper frontmatter with icon and og:image metadata

Implementation notes:

  • Follows established documentation pattern: all use-case tabs (Payouts & B2B, Ramps, Rewards, Global P2P) have webhook pages in their "Platform Tools" sections, and now the API Reference tab includes this information in "Using the API" for centralized access
  • The new page reuses the shared snippet at snippets/webhooks.mdx which contains signature verification examples, testing instructions, security considerations, and retry policy details
  • Frontmatter is consistent with other API Reference pages (uses og-api-reference.png and includes icon)

Confidence Score: 5/5

  • This PR is safe to merge with minimal risk - it's a straightforward documentation addition that follows established patterns
  • This change is extremely low-risk: it adds a new documentation page following the exact pattern used in other sections, reuses an existing tested snippet, includes proper frontmatter with valid icon and og:image paths, and correctly updates the navigation config. The JSON syntax is valid and the structure is consistent with peer pages.
  • No files require special attention

Important Files Changed

Filename Overview
mintlify/api-reference/webhooks.mdx New webhooks documentation page added to API Reference tab, following consistent pattern with other use-case tabs by importing shared webhook snippet
mintlify/docs.json Added api-reference/webhooks to the API Reference tab navigation under "Using the API" group, positioned after authentication

Last reviewed commit: feede52

@jklein24 jklein24 merged commit 2647505 into main Feb 13, 2026
6 checks passed
@jklein24 jklein24 deleted the cursor/docs-json-webhooks-template-e166 branch February 13, 2026 20:47
@greptile-apps greptile-apps bot mentioned this pull request Feb 13, 2026
AaryamanBhute pushed a commit that referenced this pull request Feb 13, 2026
Add webhooks documentation to the API Reference tab to improve
accessibility and consistency.

This change addresses feedback that webhook information should be more
accessible within the API reference section, aligning it with other key
API topics.

---
[Slack
Thread](https://lightsparkgroup.slack.com/archives/C09H6AEERDF/p1770403148012139?thread_ts=1770403148.012139&cid=C09H6AEERDF)

<p><a
href="https://cursor.com/background-agent?bcId=bc-b914b4e9-fbdf-5440-945f-fd0911acc782"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/assets/images/open-in-cursor-dark.png"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/assets/images/open-in-cursor-light.png"><img
alt="Open in Cursor" width="131" height="28"
src="https://cursor.com/assets/images/open-in-cursor-dark.png"></picture></a>&nbsp;<a
href="https://cursor.com/agents?id=bc-b914b4e9-fbdf-5440-945f-fd0911acc782"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/assets/images/open-in-web-dark.png"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/assets/images/open-in-web-light.png"><img
alt="Open in Web" width="114" height="28"
src="https://cursor.com/assets/images/open-in-web-dark.png"></picture></a></p>

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Peng Ying <pengying@users.noreply.github.com>
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