Custom Events

Custom events are used to trigger automations and can be defined with an optional schema for payload validation. If a schema is defined, payloads are validated when the event is sent. Fields that don’t match the expected type are rejected with a 422 error and the event is not delivered.

How it works

Using the dashboard
Using the API

The Events page shows all existing events. Click Add event to create a new event.Enter the event name and optional schema to define the event payload you will send with the event.

When you’re done, Save the event.

The event name can be any string (e.g., user.created, welcome, my-custom-event). Dot notation is a recommended convention but is not required. If multiple enabled automations use the same event name, all of them will be triggered.

All existing events can be retrieved using the List Events API.To create a new event, use the Create Event API.

import { Resend } from 'resend';

const resend = new Resend('re_xxxxxxxxx');

const { data, error } = await resend.events.create({
  name: 'user.created',
  schema: {
    plan: 'string',
  },
});

View the Create Event API reference for the full endpoint specification.

Configuration

config.name

string

required

The name of the custom event to create. Used to match events to automation triggers.

Event names cannot start with the resend: prefix, which is reserved for system events.

config.schema

object

An optional schema definition for the event payload. Must be an object with flat key/type pairs. Supported types: string, number, boolean, date.

Example

{
  "schema": {
    "plan": "string",
    "amount": "number",
    "date": "date",
    "is_active": "boolean"
  }
}

Documentation

Quickstart

Learn

Resources

How it works

Configuration

Documentation

Quickstart

Learn

Resources

​How it works

​Configuration

How it works

Configuration