Duffel.WebhookDeliveries (Duffel v0.1.0)

Copy Markdown View Source

Inspect delivery attempts for your webhooks.

See the Duffel documentation.

Summary

Functions

Retrieves a single webhook delivery by ID.

Lists one page of webhook deliveries.

Lazily streams all webhook deliveries across pages.

Functions

get(client, id)

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

Retrieves a single webhook delivery 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 deliveries.

Parameters

  • :webhook_id - filter by webhook
  • :delivery_success - filter by delivery outcome (boolean)
  • :limit / :after / :before - pagination (see Duffel.Page)

stream(client, params \\ [])

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

Lazily streams all webhook deliveries across pages.

Takes the same parameters as list/2. Raises Duffel.Error if a page request fails.