Creating an event key

“Event Keys” are unique keys that allow applications to send (aka publish) events to Inngest. When using Event Keys with the Inngest SDK, you can configure the Inngest client in 2 ways:

  1. Setting the key as an INNGEST_EVENT_KEY environment variable in your application*
  2. Passing the key as an argument
// Recommended: Set an INNGEST_EVENT_KEY environment variable for automatic configuration:
const inngest = new Inngest({ name: "Your app name" });

// Or you can pass the eventKey explicitly to the constructor:
const inngest = new Inngest({ name: "Your app name", eventKey: "xyz..." });

// With the Event Key, you're now ready to send data:
inngest.send(...)

* Our Vercel integration automatically sets the INNGEST_EVENT_KEY as an environment variable for you

Creating a new Event Key

From the Inngest Cloud dashboard, Event Keys are listed in the "Sources" tab:

  1. Click on “Sources” (direct link)
  2. Click the "+ Create an Event Key" button at the top right
  3. Update the Event Key's name to something descriptive and click "Save changes"
  4. Copy the newly created key using the “Copy” button:

A newly created Event Key in the Inngest Cloud dashboard

🎉 You can now use this event key with the Inngest SDK to send events directly from any codebase. You can also:

  • Rename your source at any time using the “Name” field so you and your team can identify it later
  • Delete the source when your key is no longer needed
  • Filter events by name or IP addresses for increased control and security

Best practices

  1. We recommend creating a unique key per source and per environment (production/test - Tip: use the environment "test mode" toggle on the sidebar)
  2. For client-side sources where the event key may be visible in the browser, we recommend filtering events by name (e.g. website/page.viewed or pattern website/*) to discourage spam events from being sent to your Inngest Cloud account.