docs/troubleshooting-alerts.mdx
We support receiving alerts for the following events:
a run fails
a deployment fails
a deployment succeeds
</Step></Step>
</Steps>For the alert webhooks you can use the SDK to parse them. Here is an example of how to parse the webhook payload in Remix:
import { ActionFunctionArgs, json } from "@remix-run/server-runtime";
import { webhooks, WebhookError } from "@trigger.dev/sdk";
export async function action({ request }: ActionFunctionArgs) {
// Make sure this is a POST request
if (request.method !== "POST") {
return json({ error: "Method not allowed" }, { status: 405 });
}
try {
// Construct and verify the webhook event
// This secret can be found on your Alerts page when you create a webhook alert
const event = await webhooks.constructEvent(request, process.env.ALERT_WEBHOOK_SECRET!);
// Process the event based on its type
switch (event.type) {
case "alert.run.failed": {
console.log("[Webhook Internal Test] Run failed alert webhook received", { event });
break;
}
case "alert.deployment.success": {
console.log("[Webhook Internal Test] Deployment success alert webhook received", { event });
break;
}
case "alert.deployment.failed": {
console.log("[Webhook Internal Test] Deployment failed alert webhook received", { event });
break;
}
default: {
console.log("[Webhook Internal Test] Unhandled webhook type", { event });
}
}
// Return a success response
return json({ received: true }, { status: 200 });
} catch (err) {
// Handle webhook errors
if (err instanceof WebhookError) {
console.error("Webhook error:", { message: err.message });
return json({ error: err.message }, { status: 400 });
}
if (err instanceof Error) {
console.error("Error processing webhook:", { message: err.message });
return json({ error: err.message }, { status: 400 });
}
// Handle other errors
console.error("Error processing webhook:", { err });
return json({ error: "Internal server error" }, { status: 500 });
}
}
When you create a webhook alert, you'll receive different payloads depending on the type of alert. All webhooks share some common properties:
<ParamField path="id" type="string"> A unique identifier for this webhook event </ParamField> <ParamField path="created" type="datetime"> When this webhook event was created </ParamField> <ParamField path="webhookVersion" type="string"> The version of the webhook payload format </ParamField> <ParamField path="type" type="string"> The type of alert webhook. One of: `alert.run.failed`, `alert.deployment.success`, or `alert.deployment.failed` </ParamField>This webhook is sent when a run fails. The payload is available on the object property:
This webhook is sent when a deployment succeeds. The payload is available on the object property:
This webhook is sent when a deployment fails. The payload is available on the object property: