Nuntly.WebhooksEvents (nuntly v0.1.0)

Copy Markdown View Source

Inspect webhook event history and replay failed deliveries for debugging or recovery.

Summary

Functions

list_webhook_event_deliveries(client, id, event_id, opts \\ [])

List Webhook Event Deliveries

Returns all delivery attempts for a webhook event, including HTTP status codes and response times.

Arguments

  • client — A Nuntly.Client returned by Nuntly.new/1.
  • id — Required path parameter, string.
  • event_id — Required path parameter, string.
  • opts — Optional keyword list passed to Req for this request.

Example

client = Nuntly.new(api_key: "ntly_...")

Nuntly.WebhooksEvents.list_webhook_event_deliveries(client, "id", "event-id")

list_webhooks_events(client, params \\ %{}, opts \\ [])

List Webhooks Events

Returns recent webhook events across all registered endpoints.

Arguments

  • client — A Nuntly.Client returned by Nuntly.new/1.
  • params — Optional map of query parameters:
    • "cursor" — Optional query parameter, string. Pagination cursor from a previous response
    • "limit" — Optional query parameter, integer. Maximum number of items to return Defaults to 30.
  • opts — Optional keyword list passed to Req for this request.

Example

client = Nuntly.new(api_key: "ntly_...")

Nuntly.WebhooksEvents.list_webhooks_events(
  client,
  %{
    "cursor" => "cursor",
    "limit" => 30
  }
)

replay_webhook_event(client, id, event_id, opts \\ [])

Replay Webhook Event

Re-deliver a webhook event to its endpoint. Useful for retrying failed deliveries.

Arguments

  • client — A Nuntly.Client returned by Nuntly.new/1.
  • id — Required path parameter, string.
  • event_id — Required path parameter, string.
  • opts — Optional keyword list passed to Req for this request.

Example

client = Nuntly.new(api_key: "ntly_...")

Nuntly.WebhooksEvents.replay_webhook_event(client, "id", "event-id")