Your first notification

Create and run Chaski

npx chaskijs init

pnpm dlx chaskijs init

yarn dlx chaskijs init

bun x chaskijs init

Run it in the Chaski project it creates:

npx wrangler dev

The dashboard is at http://localhost:8787, signed in as the identity under access.dev in wrangler.jsonc. Local development has the details.

Turn on two channels

Open Channels in the local dashboard. Every channel starts off, so save a sender address for Email and turn In-app on. A channel with no saved settings is skipped on every send, with the reason recorded on the delivery.

Create the template

Under Templates, create one for the type payment_received and turn on email and in-app. Write what a person reads, with the values your app will send:

Payment of {{ amount }} received

<p>Thanks, {{ recipient.name }}. We received your payment of {{ amount }}.</p>

Give the in-app content a title and a message of the same kind, save sample data with the template, and check the preview. Templates covers languages and formatting.

Connect your app

Connect your app sets this up in full. The short version: bind your app’s Worker to the local Chaski by its Worker name, mount the user routes, then run your app on another port while Chaski runs:

npx wrangler dev --port 8788

A service binding finds a Worker another wrangler dev runs on the same machine by name, so your app reaches the local Chaski as it will reach the deployed one.

Send it

Send from a route you can call, such as the handler that records a payment:

await env.CHASKI.send({
  type: 'payment_received',
  recipient: { id: user.id, email: user.email, name: user.name },
  payload: { amount: '$15.00' },
  idempotencyKey: `payment:${payment.id}`,
});

Call the route, then open Deliveries in the local dashboard and follow each delivery from pending to sent. Read the emails shows where the local email went. A delivery that shows as skipped names its reason; when one does not go out at all, Troubleshooting starts from that reason.