[PR #2125] feat: add more webhook events #2062

Open
opened 2026-02-26 20:32:16 +03:00 by kerem · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/documenso/documenso/pull/2125
Author: @ephraimduncan
Created: 11/1/2025
Status: 🔄 Open

Base: mainHead: feat/webhooks


📝 Commits (4)

  • 776cd3a feat: add more webhook events
  • f6f6627 docs: document additional webhook events and payloads
  • 3bcd023 Merge branch 'main' into feat/webhooks
  • 5388f20 Merge branch 'main' into feat/webhooks

📊 Changes

11 files changed (+916 additions, -7 deletions)

View changed files

📝 apps/documentation/pages/developers/webhooks.mdx (+595 -1)
📝 packages/lib/server-only/document/complete-document-with-token.ts (+27 -1)
📝 packages/lib/server-only/document/resend-document.ts (+13 -0)
📝 packages/lib/server-only/document/viewed-document.ts (+8 -2)
📝 packages/lib/server-only/envelope/create-envelope.ts (+7 -0)
📝 packages/lib/server-only/envelope/update-envelope.ts (+22 -2)
📝 packages/lib/server-only/template/create-document-from-template.ts (+7 -0)
📝 packages/lib/server-only/template/delete-template.ts (+18 -1)
📝 packages/lib/server-only/webhooks/trigger/generate-sample-data.ts (+193 -0)
packages/prisma/migrations/20251101000330_add_new_webhook_events/migration.sql (+17 -0)
📝 packages/prisma/schema.prisma (+9 -0)

📄 Description

This pull request adds 9 new webhook event types to Documenso, so you can track document and template actions in real time. Here's what you get now:

Document events:

  1. DOCUMENT_VIEWED – Triggered everytime someone opens a document
  2. DOCUMENT_RECIPIENT_COMPLETED – Triggered when a recipient finishes their part
  3. DOCUMENT_DOWNLOADED – Triggered on download
  4. DOCUMENT_REMINDER_SENT – Triggered when a reminder goes out

Template events:

  1. TEMPLATE_CREATED – Triggered when you create a template
  2. TEMPLATE_UPDATED – Triggered when you edit a template
  3. TEMPLATE_DELETED – Triggered when you delete a template
  4. TEMPLATE_USED – Triggered when a template is used to create a template

Security event:
9. RECIPIENT_AUTHENTICATION_FAILED – Triggered when recipient 2FA authentication fails


🔄 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/2125 **Author:** [@ephraimduncan](https://github.com/ephraimduncan) **Created:** 11/1/2025 **Status:** 🔄 Open **Base:** `main` ← **Head:** `feat/webhooks` --- ### 📝 Commits (4) - [`776cd3a`](https://github.com/documenso/documenso/commit/776cd3aa8b75ab5d6d14e5c5e630e8d974b0a8ee) feat: add more webhook events - [`f6f6627`](https://github.com/documenso/documenso/commit/f6f66272b251fdb328dc896e4ed37dcd2ed9c337) docs: document additional webhook events and payloads - [`3bcd023`](https://github.com/documenso/documenso/commit/3bcd023b005e102461527d89e843c8a442926671) Merge branch 'main' into feat/webhooks - [`5388f20`](https://github.com/documenso/documenso/commit/5388f202b52f814d2cbf9afa0f6f7f8d33f562ac) Merge branch 'main' into feat/webhooks ### 📊 Changes **11 files changed** (+916 additions, -7 deletions) <details> <summary>View changed files</summary> 📝 `apps/documentation/pages/developers/webhooks.mdx` (+595 -1) 📝 `packages/lib/server-only/document/complete-document-with-token.ts` (+27 -1) 📝 `packages/lib/server-only/document/resend-document.ts` (+13 -0) 📝 `packages/lib/server-only/document/viewed-document.ts` (+8 -2) 📝 `packages/lib/server-only/envelope/create-envelope.ts` (+7 -0) 📝 `packages/lib/server-only/envelope/update-envelope.ts` (+22 -2) 📝 `packages/lib/server-only/template/create-document-from-template.ts` (+7 -0) 📝 `packages/lib/server-only/template/delete-template.ts` (+18 -1) 📝 `packages/lib/server-only/webhooks/trigger/generate-sample-data.ts` (+193 -0) ➕ `packages/prisma/migrations/20251101000330_add_new_webhook_events/migration.sql` (+17 -0) 📝 `packages/prisma/schema.prisma` (+9 -0) </details> ### 📄 Description This pull request adds 9 new webhook event types to Documenso, so you can track document and template actions in real time. Here's what you get now: **Document events:** 1. DOCUMENT_VIEWED – Triggered everytime someone opens a document 2. DOCUMENT_RECIPIENT_COMPLETED – Triggered when a recipient finishes their part 3. DOCUMENT_DOWNLOADED – Triggered on download 4. DOCUMENT_REMINDER_SENT – Triggered when a reminder goes out **Template events:** 5. TEMPLATE_CREATED – Triggered when you create a template 6. TEMPLATE_UPDATED – Triggered when you edit a template 7. TEMPLATE_DELETED – Triggered when you delete a template 8. TEMPLATE_USED – Triggered when a template is used to create a template **Security event:** 9. RECIPIENT_AUTHENTICATION_FAILED – Triggered when recipient 2FA authentication fails --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
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#2062
No description provided.