Introducing the Inngest TypeScript / JavaScript SDK
Join our Discord
Sign up for free

Netlify

We provide a Netlify build plugin, netlify-plugin-inngest, that allows you to automatically deploy any found functions whenever your site is deployed to Netlify.

Setup

  1. Install netlify-plugin-inngest as a dev dependency:
sh
npm install --save-dev netlify-plugin-inngest
# or
yarn add --dev netlify-plugin-inngest
  1. Create or edit a netlify.toml file at the root of your project with the following:
toml
[[plugins]]
package = "netlify-plugin-inngest"

Done! 🥳 Whenever your site is deployed, your functions hosted at /api/inngest will be registered.

Configuration

If you want to use a URL that isn't your "primary" Netlify domain, or your functions are served at a different path, provide either host, path, or both as inputs in the same file:

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