Module to be used within user code to setup an Inngest function. Making it servable and invokable.

Creating an Inngest function is as easy as using Inngest.Function. It creates the necessary attributes and handlers it needs to work with Inngest.

defmodule MyApp.Inngest.SomeJob do
  use Inngest.Function
  alias Inngest.{FnOpts, Trigger}

  @func %FnOpts{id: "my-func", name: "some job"}
  @trigger %Trigger{event: "job/foobar"}

  @impl true
  def exec(ctx, input) do
    {:ok, "hello world"}
  end

  # Optional handler to handle failures when the function fails
  # after all retries are exhausted.
  def handle_failure(ctx, %{step: step} = _args) do
    _ = step.run(ctx, "handle-failure", fn ->
      "Do something here"
    end)

    {:ok, "error handled"}
  end
end

Function Options

Assign Inngest.FnOpts to @func to configure the function. See Inngest.FnOpts to see what options are available.

Trigger

A trigger is causes a function to run. One of the following is required, and they're mutually exclusive.

event - string and/or expression - string

The name of the event that will trigger this event to run. We recommend it to name it with a prefix so it's a easier pattern to identify what it's for.

e.g. auth/signup.email.send

cron - string

A unix-cron compatible schedule string.

Optional timezone prefix, e.g. TZ=Europe/Paris 0 12 * * 5.