Relay/ docs

Getting started

Quickstart

Send your first event with Relay in under five minutes. You'll install the SDK, create an API key and deliver a test event to a webhook.

1. Install the SDK

npm install @relay/sdk

2. Send an event

import { Relay } from "@relay/sdk";

const relay = new Relay(process.env.RELAY_KEY);

await relay.events.send({
  type: "order.created",
  data: { id: "ord_1042", total: 4800 },
});
Tip: use a test key while you build. Test events never reach production endpoints.