Local development

Inngest's tooling makes it easy to test your functions locally with any framework using the Inngest dev server.

Inngest Dev Server

The Inngest dev server is an open source environment that:

1. Runs a fast, in-memory version of Inngest on your machine
2. Provides a browser interface for sending events and viewing events and function runs

To start the dev server is a single command. It will scan for ports and common endpoints for an Inngest serve API endpoint (list of ports):

npx inngest-cli@latest dev
# You can also tell the local URL for the dev server to check
npx inngest-cli@latest dev -u http://localhost:3333/api/inngest

You can now open the dev server's browser interface on http://localhost:8288.

How functions are loaded by the Dev Server

The dev server polls your app locally for any new or changed functions. Then as events are sent, the dev server calls your functions directly, just as Inngest would do in production over the public internet.

Sending events to the Dev Server

There are different ways that you can send events to the dev server when testing locally:

1. Using the Inngest SDK
2. Using the "Send event" button in the Dev Server's interface
3. Via HTTP request (e.g. curl)

Using the Inngest SDK

When using the Inngest SDK locally, it tries to detect if the dev server is running on your machine. If it's running, the event will be sent there.

const inngest = new Inngest({ name: "My App" });
await inngest.send({
  name: "user.avatar.uploaded",
  data: { url: "https://a-bucket.s3.us-west-2.amazonaws.com/..." }
});

Note - During local development, you can use a dummy value for your INNGEST_EVENT_KEY environment variable. The dev server does not validate keys locally.

Using the "Send event" button

The dev server's interface also has a "Send event" button on the top right that enables you to enter any JSON event payload and send it manually. This is useful for testing out different variants of event payloads with your functions.

Via HTTP request

All events are sent to Inngest using a simple HTTP API with a JSON body. Here is an example of a curl request to the local dev server's /e/<EVENT_KEY> endpoint running on the default port of 8228 using a dummy event key of 123:

curl -X POST -v "http://localhost:8288/e/123" \
  -d '{
    "name": "user.avatar.uploaded",
    "data": { "url": "https://a-bucket.s3.us-west-2.amazonaws.com/..." }
  }'

Inngest SDK Debug page

When developing locally, by default, the SDK's serve API endpoint will display a landing page that allows you to check that your functions have been successfully served.

To view this, you can visit the route where (default /api/inngest) on your local serve, e.g. http://localhost:3000/api/inngest. In the below screenshot, you can see that a single function is being served: