Alert Webhook improvements (#1703)

* WIP with webhook SDK function and types

* JSDocs added to the schema

* Webhooks are working

* Expanded the alert docs

* Remove duplicate export of waitUntil.js

* Use uncrypto

* Don’t rate limit webhooks

* Create slow-olives-fix.md

Author: matt-aitken

.changeset/slow-olives-fix.md

@@ -0,0 +1,16 @@
+---
+"@trigger.dev/sdk": patch
+---
+
+You can add Alerts in the dashboard. One of these is a webhook, which this change greatly improves.
+
+The main change is that there's now an SDK function to verify and parse them (similar to Stripe SDK).
+
+```ts
+const event = await webhooks.constructEvent(request, process.env.ALERT_WEBHOOK_SECRET!);
+```
+
+If the signature you provide matches the one from the dashboard when you create the webhook, you will get a nicely typed object back for these three types:
+- "alert.run.failed"
+- "alert.deployment.success"
+- "alert.deployment.failed"

apps/webapp/app/models/projectAlert.server.ts

@@ -4,6 +4,7 @@ import { EncryptedSecretValueSchema } from "~/services/secrets/secretStore.serve
 export const ProjectAlertWebhookProperties = z.object({
   secret: EncryptedSecretValueSchema,
   url: z.string(),
+  version: z.string().optional().default("v1"),
 });
 
 export type ProjectAlertWebhookProperties = z.infer<typeof ProjectAlertWebhookProperties>;

apps/webapp/app/routes/internal.webhooks.tester.ts

@@ -0,0 +1,50 @@
+import { ActionFunctionArgs, json } from "@remix-run/server-runtime";
+import { webhooks } from "@trigger.dev/sdk/v3";
+import { WebhookError } from "@trigger.dev/sdk/v3";
+import { logger } from "~/services/logger.server";
+
+/*
+  This route is for testing our webhooks
+*/
+export async function action({ request }: ActionFunctionArgs) {
+  // Make sure this is a POST request
+  if (request.method !== "POST") {
+    return json({ error: "[Webhook Internal Test] Method not allowed" }, { status: 405 });
+  }
+
+  const clonedRequest = request.clone();
+  const rawBody = await clonedRequest.text();
+  logger.log("[Webhook Internal Test] Raw body:", { rawBody });
+
+  try {
+    // Construct and verify the webhook event
+    const event = await webhooks.constructEvent(request, process.env.INTERNAL_TEST_WEBHOOK_SECRET!);
+
+    // Handle the webhook event
+    logger.log("[Webhook Internal Test] Received verified webhook:", event);
+
+    // Process the event based on its type
+    switch (event.type) {
+      default:
+        logger.log(`[Webhook Internal Test] Unhandled event type: ${event.type}`);
+    }
+
+    // Return a success response
+    return json({ received: true }, { status: 200 });
+  } catch (err) {
+    // Handle webhook errors
+    if (err instanceof WebhookError) {
+      logger.error("[Webhook Internal Test] Webhook error:", { message: err.message });
+      return json({ error: err.message }, { status: 400 });
+    }
+
+    if (err instanceof Error) {
+      logger.error("[Webhook Internal Test] Error processing webhook:", { message: err.message });
+      return json({ error: err.message }, { status: 400 });
+    }
+
+    // Handle other errors
+    logger.error("[Webhook Internal Test] Error processing webhook:", { err });
+    return json({ error: "Internal server error" }, { status: 500 });
+  }
+}

apps/webapp/app/v3/services/alerts/createAlertChannel.server.ts

@@ -100,6 +100,7 @@ export class CreateAlertChannelService extends BaseService {
         return {
           url: channel.url,
           secret: await encryptSecret(env.ENCRYPTION_KEY, channel.secret ?? nanoid()),
+          version: "v2",
         };
       case "SLACK":
         return {