Behaviour for handling verified Stripe webhook events.

Implement this behaviour in your application to handle incoming webhook events dispatched by LatticeStripe.Plug.Webhook (or your own dispatcher). The handler receives a fully verified and typed %LatticeStripe.Event{} struct — signature has already been verified before handle_event/1 is called.

Example

defmodule MyApp.StripeHandler do
  @behaviour LatticeStripe.Webhook.Handler

  @impl true
  def handle_event(%LatticeStripe.Event{type: "payment_intent.succeeded"} = event) do
    MyApp.Payments.fulfill(event.data["object"])
    :ok
  end

  def handle_event(%LatticeStripe.Event{type: "customer.subscription.deleted"} = event) do
    MyApp.Subscriptions.cancel(event.data["object"])
    :ok
  end

  # Catch-all for events you don't handle explicitly
  def handle_event(_event), do: :ok
end

Return Values

• :ok — event handled successfully
• {:ok, term()} — event handled successfully, with a return value (ignored by dispatcher)
• :error — event handling failed (dispatcher may log or return 500)
• {:error, term()} — event handling failed with a reason (dispatcher may log or return 500)