Netlify Plugin Inngest

1.0.1 · active · verified Sun Apr 19

netlify-plugin-inngest is a Netlify Build plugin designed to automate the registration of serverless Inngest functions within a Netlify deployment. Currently at version 1.0.1, this plugin runs during the Netlify build process, identifying and configuring the necessary endpoints for Inngest to discover and invoke your serverless functions. Its primary differentiation lies in simplifying the setup for Inngest on Netlify, abstracting away manual configuration steps by integrating directly with the Netlify Build system. While a specific release cadence isn't published, updates are typically released in conjunction with Inngest platform enhancements or to align with Netlify's build environment changes, ensuring seamless compatibility and a streamlined developer experience for users leveraging both platforms. The plugin focuses on providing a robust, opinionated way to connect Netlify-hosted code with the Inngest event-driven platform.

Common errors

```
Plugin "netlify-plugin-inngest" was not found.
```
cause The plugin package is not correctly installed or referenced in `netlify.toml`.

fix Add `[[plugins]] package = "netlify-plugin-inngest"` to your `netlify.toml` and ensure `netlify-plugin-inngest` is installed via npm/yarn if manually added, or through the Netlify UI.
```
Function not found at path: /api/inngest
```
cause The Inngest handler path specified (or defaulted to) does not match the deployed Netlify Function endpoint.

fix Check the `path` input in `netlify.toml` and verify it matches the actual deployed Netlify Function path. Ensure the Netlify Function itself is deployed correctly and accessible.
```
Build failed with exit code 1
```
cause An internal error within the plugin during the build process, possibly due to unexpected build environment or conflicting configurations.

fix Examine the detailed build logs for specific error messages from `netlify-plugin-inngest`. Ensure Netlify's Node.js version meets the plugin's requirements (Node.js >=12.20.0). Consider updating the plugin to the latest version.

Warnings

gotcha Improper `host` configuration in `netlify.toml` can lead to Inngest functions being registered with an incorrect base URL, making them unreachable or causing event delivery failures.
Fix: Ensure the `host` input precisely matches the live domain where your Netlify site is accessible. If not provided, Netlify's main site URL is used, which may not be the canonical domain if custom domains are configured without redirection.
gotcha Incorrect `path` input for the Inngest handler may result in Inngest functions not being discoverable by the Inngest service, as the plugin registers the wrong endpoint.
Fix: Verify that the `path` input in `netlify.toml` (defaults to `/api/inngest`) accurately reflects the actual path where your Inngest handler is exposed in your Netlify serverless functions.
gotcha As a Netlify Build plugin, `netlify-plugin-inngest` operates within the build environment. Conflicts with other build plugins or custom build scripts that modify serverless function outputs or environment variables can disrupt Inngest function registration.
Fix: Review the build log for plugin-related errors. If issues arise, temporarily disable other plugins or build commands to isolate the conflict. Ensure that the Inngest handler is correctly bundled and deployed as a Netlify Function.
gotcha The plugin requires your Inngest serverless handler to be present and correctly deployed as a Netlify Function. If the underlying Inngest function deployment fails or the handler is missing, the plugin cannot register it correctly.
Fix: Confirm that your Inngest handler code is correctly located within your `netlify/functions` directory (or configured functions directory) and builds without errors. Test the raw Netlify Function endpoint directly if possible.

Install

npm install netlify-plugin-inngest npm
yarn add netlify-plugin-inngest yarn
pnpm add netlify-plugin-inngest pnpm

Quickstart

Configures the Netlify Build plugin to automatically register Inngest functions, optionally specifying a custom host and path for the Inngest handler.

[[plugins]]
package = "netlify-plugin-inngest"

  [plugins.inputs]
    host = "https://my-specific-domain.com"
    path = "/api/inngest"

view raw JSON →