payload-plugin-newsletter 0.21.4 → 0.23.0

package/CHANGELOG.md

@@ -1,3 +1,30 @@
+## [0.23.0] - 2025-08-07
+
+### Added
+- **Complete webhook sync for Broadcast subscribers**: Added support for three new webhook events
+  - `subscriber.created`: Syncs new subscribers created in Broadcast interface to Payload
+  - `subscriber.updated`: Syncs subscriber updates from Broadcast to Payload
+  - `subscriber.deleted`: Removes subscribers from Payload when deleted in Broadcast
+- **Bidirectional sync**: Now provides complete two-way synchronization between Broadcast and Payload
+
+### Changed
+- Enhanced webhook event handling to support all subscriber lifecycle events
+- Improved logging for better webhook debugging
+
+## [0.22.0] - 2025-08-07
+
+### Changed
+- **Improved Broadcast sync**: Now uses proper subscribe/unsubscribe endpoints
+  - Uses `/api/v1/subscribers/unsubscribe.json` for unsubscribing (sets `unsubscribed_at` timestamp)
+  - Uses `/api/v1/subscribers.json` for both new subscriptions and resubscriptions
+  - Removed language tagging as per user preference
+  - Simplified resubscription flow - no special error handling needed
+- **Better compliance tracking**: Broadcast now properly tracks unsubscribe timestamps for compliance
+
+### Fixed
+- Fixed Broadcast provider to properly handle subscription status changes
+- Removed unnecessary contact existence checks (Broadcast API handles this gracefully)
+
 ## [0.21.4] - 2025-08-07
 
 ### Fixed

package/dist/server.js

@@ -1240,13 +1240,11 @@ var BroadcastProvider = class {
             email: contact.email,
             first_name: firstName || void 0,
             last_name: lastName || void 0,
-            tags: [`lang:${contact.locale || "en"}`],
-            is_active: contact.subscriptionStatus === "active",
             source: contact.source
           }
         })
       });
-      if (!response.ok) {
+      if (!response.ok && response.status !== 201) {
         const error = await response.text();
         throw new Error(`Broadcast API error: ${response.status} - ${error}`);
       }
@@ -1260,44 +1258,39 @@ var BroadcastProvider = class {
   }
   async updateContact(contact) {
     try {
-      const searchResponse = await fetch(
-        `${this.apiUrl}/api/v1/subscribers/find.json?email=${encodeURIComponent(contact.email)}`,
-        {
+      const [firstName, ...lastNameParts] = (contact.name || "").split(" ");
+      const lastName = lastNameParts.join(" ");
+      if (contact.subscriptionStatus === "unsubscribed") {
+        const response2 = await fetch(`${this.apiUrl}/api/v1/subscribers/unsubscribe.json`, {
+          method: "POST",
           headers: {
-            "Authorization": `Bearer ${this.token}`
-          }
+            "Authorization": `Bearer ${this.token}`,
+            "Content-Type": "application/json"
+          },
+          body: JSON.stringify({ email: contact.email })
+        });
+        if (!response2.ok) {
+          const error = await response2.text();
+          throw new Error(`Broadcast API error: ${response2.status} - ${error}`);
         }
-      );
-      if (!searchResponse.ok) {
-        await this.addContact(contact);
-        return;
-      }
-      const existingContact = await searchResponse.json();
-      if (!existingContact || !existingContact.id) {
-        await this.addContact(contact);
         return;
       }
-      const [firstName, ...lastNameParts] = (contact.name || "").split(" ");
-      const lastName = lastNameParts.join(" ");
       const response = await fetch(`${this.apiUrl}/api/v1/subscribers.json`, {
-        method: "PATCH",
+        method: "POST",
         headers: {
           "Authorization": `Bearer ${this.token}`,
           "Content-Type": "application/json"
         },
         body: JSON.stringify({
-          email: contact.email,
-          // Email at root level to identify the subscriber
           subscriber: {
+            email: contact.email,
             first_name: firstName || void 0,
             last_name: lastName || void 0,
-            tags: [`lang:${contact.locale || "en"}`],
-            is_active: contact.subscriptionStatus === "active",
             source: contact.source
           }
         })
       });
-      if (!response.ok) {
+      if (!response.ok && response.status !== 201) {
         const error = await response.text();
         throw new Error(`Broadcast API error: ${response.status} - ${error}`);
       }
@@ -1311,22 +1304,7 @@ var BroadcastProvider = class {
   }
   async removeContact(email) {
     try {
-      const searchResponse = await fetch(
-        `${this.apiUrl}/api/v1/subscribers/find.json?email=${encodeURIComponent(email)}`,
-        {
-          headers: {
-            "Authorization": `Bearer ${this.token}`
-          }
-        }
-      );
-      if (!searchResponse.ok) {
-        return;
-      }
-      const contact = await searchResponse.json();
-      if (!contact || !contact.id) {
-        return;
-      }
-      const response = await fetch(`${this.apiUrl}/api/v1/subscribers/deactivate.json`, {
+      const response = await fetch(`${this.apiUrl}/api/v1/subscribers/unsubscribe.json`, {
         method: "POST",
         headers: {
           "Authorization": `Bearer ${this.token}`,
@@ -2464,6 +2442,9 @@ function verifyBroadcastWebhookSignature(payload, signature, timestamp, secret)
 // src/types/webhooks.ts
 var WEBHOOK_EVENT_TYPES = {
   // Subscriber events
+  SUBSCRIBER_CREATED: "subscriber.created",
+  SUBSCRIBER_UPDATED: "subscriber.updated",
+  SUBSCRIBER_DELETED: "subscriber.deleted",
   SUBSCRIBER_SUBSCRIBED: "subscriber.subscribed",
   SUBSCRIBER_UNSUBSCRIBED: "subscriber.unsubscribed",
   // Broadcast events
@@ -2491,6 +2472,15 @@ async function handleSubscriberEvent(event, req, config) {
   const { payload } = req;
   const subscribersSlug = config.subscribersSlug || "subscribers";
   switch (event.type) {
+    case WEBHOOK_EVENT_TYPES.SUBSCRIBER_CREATED:
+      await handleSubscriberCreated(event, payload, subscribersSlug);
+      break;
+    case WEBHOOK_EVENT_TYPES.SUBSCRIBER_UPDATED:
+      await handleSubscriberUpdated(event, payload, subscribersSlug);
+      break;
+    case WEBHOOK_EVENT_TYPES.SUBSCRIBER_DELETED:
+      await handleSubscriberDeleted(event, payload, subscribersSlug);
+      break;
     case WEBHOOK_EVENT_TYPES.SUBSCRIBER_SUBSCRIBED:
       await handleSubscriberSubscribed(event, payload, subscribersSlug);
       break;
@@ -2579,6 +2569,110 @@ async function handleSubscriberUnsubscribed(event, payload, subscribersSlug) {
     throw error;
   }
 }
+async function handleSubscriberCreated(event, payload, subscribersSlug) {
+  const { data } = event;
+  try {
+    const existing = await payload.find({
+      collection: subscribersSlug,
+      where: {
+        email: {
+          equals: data.email
+        }
+      },
+      limit: 1
+    });
+    if (existing.docs.length > 0) {
+      const subscriber = existing.docs[0];
+      await payload.update({
+        collection: subscribersSlug,
+        id: subscriber.id,
+        data: {
+          name: data.name || subscriber.name,
+          externalId: data.id,
+          source: data.source || subscriber.source,
+          // Don't change subscription status on created event
+          ...data.attributes && { attributes: data.attributes }
+        }
+      });
+      console.log("[Subscriber Handler] Updated existing subscriber on created event:", data.email);
+    } else {
+      await payload.create({
+        collection: subscribersSlug,
+        data: {
+          email: data.email,
+          name: data.name,
+          subscriptionStatus: "pending",
+          // New subscribers start as pending
+          externalId: data.id,
+          source: data.source,
+          attributes: data.attributes || {}
+        }
+      });
+      console.log("[Subscriber Handler] Created new subscriber:", data.email);
+    }
+  } catch (error) {
+    console.error("[Subscriber Handler] Error handling created event:", error);
+    throw error;
+  }
+}
+async function handleSubscriberUpdated(event, payload, subscribersSlug) {
+  const { data } = event;
+  try {
+    const existing = await payload.find({
+      collection: subscribersSlug,
+      where: {
+        email: {
+          equals: data.email
+        }
+      },
+      limit: 1
+    });
+    if (existing.docs.length > 0) {
+      const subscriber = existing.docs[0];
+      await payload.update({
+        collection: subscribersSlug,
+        id: subscriber.id,
+        data: {
+          name: data.name || subscriber.name,
+          ...data.attributes && { attributes: data.attributes }
+        }
+      });
+      console.log("[Subscriber Handler] Updated subscriber:", data.email);
+    } else {
+      console.warn("[Subscriber Handler] Subscriber not found for update:", data.email);
+    }
+  } catch (error) {
+    console.error("[Subscriber Handler] Error handling updated event:", error);
+    throw error;
+  }
+}
+async function handleSubscriberDeleted(event, payload, subscribersSlug) {
+  const { data } = event;
+  try {
+    const existing = await payload.find({
+      collection: subscribersSlug,
+      where: {
+        email: {
+          equals: data.email
+        }
+      },
+      limit: 1
+    });
+    if (existing.docs.length > 0) {
+      const subscriber = existing.docs[0];
+      await payload.delete({
+        collection: subscribersSlug,
+        id: subscriber.id
+      });
+      console.log("[Subscriber Handler] Deleted subscriber:", data.email);
+    } else {
+      console.warn("[Subscriber Handler] Subscriber not found for deletion:", data.email);
+    }
+  } catch (error) {
+    console.error("[Subscriber Handler] Error handling deleted event:", error);
+    throw error;
+  }
+}
 
 // src/webhooks/handlers/broadcast.ts
 var STATUS_MAP = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payload-plugin-newsletter",
-  "version": "0.21.4",
+  "version": "0.23.0",
   "description": "Complete newsletter management plugin for Payload CMS with subscriber management, magic link authentication, and email service integration",
   "type": "module",
   "main": "./dist/index.js",