triggerdotdev/scheduled-healthcheck

A starter template for Trigger.dev that checks for a 200 response from a URL and sends a notification if it doesn't get one.

✨ Trigger.dev Scheduled Healthcheck

This repo contains a Scheduled Trigger that will run every 5 minutes and send a Slack message if a website url returns a non-200 response:

new Trigger({
  // Give your Trigger a stable ID
  id: "scheduled-healthcheck",
  name: "Scheduled Healthcheck",
  // Trigger every 5 minutes, see https://docs.trigger.dev/triggers/scheduled
  on: scheduleEvent({
    rateOf: { minutes: 5 },
  }),
  // The run functions gets called every 5 minutes
  async run(event, ctx) {
    // Fetch the website using generic fetch, see https://docs.trigger.dev/functions/fetch
    const response = await ctx.fetch("🧑‍⚕️", WEBSITE_URL, {
      method: "GET",
      retry: {
        enabled: false, // Disable retrying
      },
    });

    // If the website is down (or we are in a test run), send a message to Slack
    if (!response.ok || ctx.isTest) {
      // Post a message to Slack, see https://docs.trigger.dev/integrations/apis/slack/actions/post-message
      await slack.postMessage("🤒", {
        channelName: "health-checks",
        text: `😭 ${WEBSITE_URL} is down!`,
      });
    }
  },
}).listen();

🔧 Install

You can easily create a new project interactively based on this template by running:

npx create-trigger@latest scheduled-healthcheck
# or
yarn create trigger scheduled-healthcheck
# or
pnpm create trigger@latest scheduled-healthcheck

Follow the instructions in the CLI to get up and running locally in <30s.

✍️ Customize

• You can set the website url by defining the WEBSITE_URL environment variable.
• Customize the Slack message and channel name.
• Update the frequency (you can go as frequent as once per minute)

Be sure to check out more over on our docs

🧪 Test it

After successfully running this template locally, head over to your Trigger.dev Dashboard and you should see your newly created workflow:

Click on the workflow in the list and then click on the "Test your workflow" button, where you will be able to simulate a scheduled event:

Since we setup our workflow to always post to Slack in a test run, after clicking "Run Test" you'll see a message requiring Slack authentication to continue:

Once you authenticate your Slack workspace, the run will pickup where it left off and post the message:

Head over to slack to see your newly created message: