Trigger.dev home pagelight logo
  1. SDK Reference
  2. customEvent Trigger

​
Usage

import { customEvent, Trigger } from "@trigger.dev/sdk";

new Trigger({
  id: "user-created-notify-slack",
  name: "User Created - Notify Slack",
  on: customEvent({
    name: "user.created",
    schema: z.object({ id: z.string(), admin: z.boolean() }),
    filter: {
      admin: [false],
    },
  }),
  run: async (event, ctx) => {},
}).listen();

​
Options

nameRequired
string

The name of the custom event to listen for.

filter
object

An event filter to apply to the custom event payload. See the event filter documentation for more information.

schemaRequired
Zod Schema

A Zod schema to validate the webhook event payload against. See our Zod guide for more information.