inngest

inngest-node

npm install inngest

👋 Have a question or feature request? Join our Discord!

Usage

// ES Modules / TypeScript
import { Inngest } from "inngest";
// or CommonJS
const { Inngest } = require("inngest");

const inngest = new Inngest(process.env.INNGEST_SOURCE_API_KEY);

// Send a single event
await inngest.send({
  name: "user.signup",
  data: {
    plan: account.planType,
  },
  user: {
    external_id: user.id,
    email: user.email,
  },
});

// Send events in bulk
const events = ["[phone]", "[phone]"].map(phoneNumber => ({
  name: "sms.response.requested",
  data: {
    message: "Are you available for work today? (y/n)"
  },
  user: {
    phone: phoneNumber
  }
}});
await inngest.send(events);

Contributing

Clone the repository, then:

yarn # install dependencies
yarn dev # build/lint/test

We use Volta to manage Node/Yarn versions.

When making a pull request, make sure to commit the changed etc/inngest.api.md file; this is a generated types/docs file that will highlight changes to the exposed API.