Lettermint.Webhooks.Deliveries (Lettermint v2.2.0)

Copy Markdown View Source

Delivery attempts of a webhook. Needs :team_token.

Every function takes the options timeout: (milliseconds) last.

Summary

Types

result(value)

Functions

iterate(client, webhook_id, query \\ %{}, options \\ [])

Streams every delivery of a webhook, following next_cursor. Raises the error of a failed page request.

list(client, webhook_id, query \\ %{}, options \\ [])

Lists the deliveries of a webhook, one page at a time.

retrieve(client, webhook_id, delivery_id, options \\ [])

Retrieves one delivery.

retry(client, webhook_id, delivery_id, options \\ [])

Sends a delivery's original payload to the webhook again now. The retry counts as a delivery attempt; if it fails with a retryable error, automatic retries continue. A delivery that cannot be retried returns a Lettermint.ConflictError.

Types

result(value)

@type result(value) :: {:ok, value} | {:error, Lettermint.Error.t()}

Functions

iterate(client, webhook_id, query \\ %{}, options \\ [])

@spec iterate(
  Lettermint.Client.t(),
  String.t(),
  Lettermint.Types.ListWebhookDeliveriesQuery.t(),
  keyword()
) :: Enumerable.t(Lettermint.Types.WebhookDeliveryListData.t())

Streams every delivery of a webhook, following next_cursor. Raises the error of a failed page request.

list(client, webhook_id, query \\ %{}, options \\ [])

@spec list(
  Lettermint.Client.t(),
  String.t(),
  Lettermint.Types.ListWebhookDeliveriesQuery.t(),
  keyword()
) :: result(Lettermint.Types.ListWebhookDeliveriesResponse.t())

Lists the deliveries of a webhook, one page at a time.

retrieve(client, webhook_id, delivery_id, options \\ [])

@spec retrieve(Lettermint.Client.t(), String.t(), String.t(), keyword()) ::
  result(Lettermint.Types.WebhookDeliveryData.t())

Retrieves one delivery.

retry(client, webhook_id, delivery_id, options \\ [])

@spec retry(Lettermint.Client.t(), String.t(), String.t(), keyword()) ::
  result(Lettermint.Types.RetryWebhookDeliveryResponse.t())

Sends a delivery's original payload to the webhook again now. The retry counts as a delivery attempt; if it fails with a retryable error, automatic retries continue. A delivery that cannot be retried returns a Lettermint.ConflictError.