Duffel.WebhookEvents (Duffel v0.1.0)

Copy Markdown View Source

Inspect and redeliver events sent to your webhooks.

See the Duffel documentation.

Summary

Functions

Retrieves a single webhook event by ID.

Lists one page of webhook events.

Queues a webhook event for redelivery.

Lazily streams all webhook events across pages.

Functions

get(client, id)

@spec get(Duffel.Client.t(), String.t()) :: {:ok, map()} | {:error, Duffel.Error.t()}

Retrieves a single webhook event by ID.

list(client, params \\ [])

@spec list(Duffel.Client.t(), keyword() | map()) ::
  {:ok, Duffel.Page.t()} | {:error, Duffel.Error.t()}

Lists one page of webhook events.

Parameters

  • :type - filter by event type, e.g. "order.created"
  • :delivery_success - filter by whether delivery succeeded (boolean)
  • :created_at - filter on a datetime range, e.g. created_at: %{after: "2026-07-01T00:00:00Z"}
  • :limit / :after / :before - pagination (see Duffel.Page)

redeliver(client, id)

@spec redeliver(Duffel.Client.t(), String.t()) :: :ok | {:error, Duffel.Error.t()}

Queues a webhook event for redelivery.

stream(client, params \\ [])

@spec stream(Duffel.Client.t(), keyword() | map()) :: Enumerable.t()

Lazily streams all webhook events across pages.

Raises Duffel.Error if a page request fails.