Skip to content

The Open Source DocuSign Alternative.

fix: include envelopeId in webhook payload (#2998)

Lucas Smitha99bdf5e2007
diff --git a/packages/lib/server-only/webhooks/trigger/generate-sample-data.ts b/packages/lib/server-only/webhooks/trigger/generate-sample-data.ts
index 340e6790f..af902f8ba 100644
--- a/packages/lib/server-only/webhooks/trigger/generate-sample-data.ts
+++ b/packages/lib/server-only/webhooks/trigger/generate-sample-data.ts
@@ -17,6 +17,7 @@ export const generateSampleWebhookPayload = (event: WebhookTriggerEvents, webhoo
const now = new Date();
const basePayload = {
id: 10,
+ envelopeId: 'env_123',
externalId: null,
userId: 1,
authOptions: null,
@@ -52,6 +53,7 @@ export const generateSampleWebhookPayload = (event: WebhookTriggerEvents, webhoo
recipients: [
{
id: 52,
+ envelopeId: 'env_123',
documentId: 10,
templateId: null,
@@ -73,6 +75,7 @@ export const generateSampleWebhookPayload = (event: WebhookTriggerEvents, webhoo
Recipient: [
{
id: 52,
+ envelopeId: 'env_123',
documentId: 10,
templateId: null,
@@ -269,6 +272,7 @@ export const generateSampleWebhookPayload = (event: WebhookTriggerEvents, webhoo
recipients: [
{
id: 50,
+ envelopeId: 'env_123',
documentId: 10,
templateId: null,
@@ -291,6 +295,7 @@ export const generateSampleWebhookPayload = (event: WebhookTriggerEvents, webhoo
},
{
id: 51,
+ envelopeId: 'env_123',
documentId: 10,
templateId: null,
@@ -315,6 +320,7 @@ export const generateSampleWebhookPayload = (event: WebhookTriggerEvents, webhoo
Recipient: [
{
id: 50,
+ envelopeId: 'env_123',
documentId: 10,
templateId: null,
@@ -337,6 +343,7 @@ export const generateSampleWebhookPayload = (event: WebhookTriggerEvents, webhoo
},
{
id: 51,
+ envelopeId: 'env_123',
documentId: 10,
templateId: null,
@@ -444,6 +451,7 @@ export const generateSampleWebhookPayload = (event: WebhookTriggerEvents, webhoo
recipients: [
{
id: 7,
+ envelopeId: 'env_123',
documentId: 7,
templateId: null,
@@ -468,6 +476,7 @@ export const generateSampleWebhookPayload = (event: WebhookTriggerEvents, webhoo
Recipient: [
{
id: 7,
+ envelopeId: 'env_123',
documentId: 7,
templateId: null,
diff --git a/packages/lib/types/webhook-payload.ts b/packages/lib/types/webhook-payload.ts
index a3462da8d..6820e0958 100644
--- a/packages/lib/types/webhook-payload.ts
+++ b/packages/lib/types/webhook-payload.ts
@@ -21,6 +21,7 @@ import { mapSecondaryIdToDocumentId, mapSecondaryIdToTemplateId } from '../utils
*/
export const ZWebhookRecipientSchema = z.object({
id: z.number(),
+ envelopeId: z.string(),
documentId: z.number().nullable(),
templateId: z.number().nullable(),
email: z.string(),
@@ -64,6 +65,7 @@ export const ZWebhookDocumentMetaSchema = z.object({
*/
export const ZWebhookDocumentSchema = z.object({
id: z.number(),
+ envelopeId: z.string(),
externalId: z.string().nullable(),
userId: z.number(),
authOptions: z.any().nullable(),
@@ -117,6 +119,7 @@ export const mapEnvelopeToWebhookDocumentPayload = (
const mappedRecipients = rawRecipients.map((recipient) => ({
id: recipient.id,
+ envelopeId: envelope.id,
documentId: envelope.type === EnvelopeType.DOCUMENT ? legacyId : null,
templateId: envelope.type === EnvelopeType.TEMPLATE ? legacyId : null,
email: recipient.email,
@@ -137,6 +140,7 @@ export const mapEnvelopeToWebhookDocumentPayload = (
return {
id: legacyId,
+ envelopeId: envelope.id,
externalId: envelope.externalId,
userId: envelope.userId,
authOptions: envelope.authOptions,