chore: change webhook back to object

Author: arcoraven

.changeset/mean-jars-cheat.md

@@ -0,0 +1,5 @@
+---
+"@thirdweb-dev/service-utils": patch
+---
+
+chore: data in webhook payload is an object

packages/service-utils/src/node/webhookProducer.ts

@@ -2,18 +2,22 @@ import assert from "node:assert";
 import { createId } from "@paralleldrive/cuid2";
 import type { KafkaProducer } from "./kafka.js";
 
+/**
+ * The event schema for webhook events.
+ * See more: https://github.com/thirdweb-dev/api-server/blob/dev/docs/webhooks.md
+ */
 interface WebhookEvent extends Record<string, unknown> {
-  id?: `evt_${string}`;
-  teamId: string;
-  projectId?: string;
-  /**
-   * The timestamp your event was triggered at.
-   */
-  createdAt?: Date;
-  /**
-   * An array of your model (defined in api-server). Must not be empty.
-   */
-  payload: Record<string, unknown>[];
+	id?: `evt_${string}`;
+	teamId: string;
+	projectId?: string;
+	/**
+	 * The timestamp your event was triggered at.
+	 */
+	createdAt?: Date;
+	/**
+	 * Your model defined in api-server.
+	 */
+	data: Record<string, unknown>;
 }
 
 /**
@@ -27,39 +31,38 @@ interface WebhookEvent extends Record<string, unknown> {
  * ```
  */
 export class WebhookEventProducer {
-  private kafkaProducer: KafkaProducer;
+	private kafkaProducer: KafkaProducer;
 
-  constructor(config: { kafkaProducer: KafkaProducer }) {
-    this.kafkaProducer = config.kafkaProducer;
-  }
+	constructor(config: { kafkaProducer: KafkaProducer }) {
+		this.kafkaProducer = config.kafkaProducer;
+	}
 
-  /**
-   * Emit a webhook event.
-   * This method may throw. To call this non-blocking:
-   * ```ts
-   * void webhookProducer.sendEvents(events).catch((e) => console.error(e))
-   * ```
-   */
-  async sendEvents(topic: string, events: WebhookEvent[]): Promise<void> {
-    const parsedEvents: WebhookEvent[] = events.map((event) => {
-      assert(event.payload.length > 0, "payload must not be empty");
-      assert(
-        event.teamId.startsWith("team_"),
-        "teamId must start with 'team_'",
-      );
-      assert(
-        !event.projectId || event.projectId.startsWith("prj_"),
-        "projectId must start with 'prj_'",
-      );
+	/**
+	 * Emit a webhook event.
+	 * This method may throw. To call this non-blocking:
+	 * ```ts
+	 * void webhookProducer.sendEvents(events).catch((e) => console.error(e))
+	 * ```
+	 */
+	async sendEvents(topic: string, events: WebhookEvent[]): Promise<void> {
+		const parsedEvents: WebhookEvent[] = events.map((event) => {
+			assert(
+				event.teamId.startsWith("team_"),
+				"teamId must start with 'team_'",
+			);
+			assert(
+				!event.projectId || event.projectId.startsWith("prj_"),
+				"projectId must start with 'prj_'",
+			);
 
-      return {
-        ...event,
-        // Default to now.
-        createdAt: event.createdAt ?? new Date(),
-        // Default to a generated UUID.
-        id: event.id ?? `evt_${createId()}`,
-      };
-    });
-    await this.kafkaProducer.send(topic, parsedEvents);
-  }
+			return {
+				...event,
+				// Default to now.
+				createdAt: event.createdAt ?? new Date(),
+				// Default to a generated UUID.
+				id: event.id ?? `evt_${createId()}`,
+			};
+		});
+		await this.kafkaProducer.send(topic, parsedEvents);
+	}
 }