[PR #1278] [MERGED] docs: Fix documentation typo regarding the Webhook secret header #1528

Closed
opened 2026-02-26 19:33:38 +03:00 by kerem · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/documenso/documenso/pull/1278
Author: @yigitkerem
Created: 8/10/2024
Status: Merged
Merged: 8/21/2024
Merged by: @Mythie

Base: mainHead: patch-1


📝 Commits (1)

📊 Changes

1 file changed (+1 additions, -1 deletions)

View changed files

📝 apps/documentation/pages/developers/webhooks.mdx (+1 -1)

📄 Description


name: Fix documentation typo regarding the Webhook secret header
about: Submit changes to the project for review and inclusion

Description

The documentation has inaccurate information about the Webhook security headers. This updates the docs instead of changing the code.

Could not find any, I discovered while building an integration.

Changes Made

Changed the documentation about webhook signing secrets. Despite the code to make webhook requests as such, the documentation refers to an X-Documenso-Signature header that is nonpresent.

const response = await fetch(url, {
    method: 'POST',
    body: JSON.stringify(payload),
    headers: {
      'Content-Type': 'application/json',
      'X-Documenso-Secret': secret ?? '',
    },
  });

Testing Performed

Docs will compile.

Checklist

  • I have tested these changes locally and they work as expected.
  • I have added/updated tests that prove the effectiveness of these changes.
  • I have updated the documentation to reflect these changes, if applicable.
  • I have followed the project's coding style guidelines.
  • I have addressed the code review feedback from the previous submission, if applicable.

Summary by CodeRabbit

  • Documentation
    • Updated webhook subscription documentation to reflect a change in header name from X-Documenso-Signature to X-Documenso-Secret for improved clarity on the use of the secret key.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/documenso/documenso/pull/1278 **Author:** [@yigitkerem](https://github.com/yigitkerem) **Created:** 8/10/2024 **Status:** ✅ Merged **Merged:** 8/21/2024 **Merged by:** [@Mythie](https://github.com/Mythie) **Base:** `main` ← **Head:** `patch-1` --- ### 📝 Commits (1) - [`9d448ac`](https://github.com/documenso/documenso/commit/9d448ac75a871f765bc71f9b205a0443d3c371d6) Update webhooks.mdx ### 📊 Changes **1 file changed** (+1 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `apps/documentation/pages/developers/webhooks.mdx` (+1 -1) </details> ### 📄 Description --- name: Fix documentation typo regarding the Webhook secret header about: Submit changes to the project for review and inclusion --- ## Description The documentation has inaccurate information about the Webhook security headers. This updates the docs instead of changing the code. ## Related Issue Could not find any, I discovered while building an integration. ## Changes Made Changed the documentation about webhook signing secrets. Despite the code to make webhook requests as such, the documentation refers to an `X-Documenso-Signature` header that is nonpresent. ```js const response = await fetch(url, { method: 'POST', body: JSON.stringify(payload), headers: { 'Content-Type': 'application/json', 'X-Documenso-Secret': secret ?? '', }, }); ``` ## Testing Performed Docs will compile. ## Checklist - [x] I have tested these changes locally and they work as expected. - [x] I have added/updated tests that prove the effectiveness of these changes. - [x] I have updated the documentation to reflect these changes, if applicable. - [x] I have followed the project's coding style guidelines. - [x] I have addressed the code review feedback from the previous submission, if applicable. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Updated webhook subscription documentation to reflect a change in header name from `X-Documenso-Signature` to `X-Documenso-Secret` for improved clarity on the use of the secret key. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
kerem 2026-02-26 19:33:38 +03:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/documenso#1528
No description provided.