Skip to main content

useWebhookDeliveries

The useWebhookDeliveries hook fetches delivery logs and pagination metadata.

Parameters

options.endpoint_id
string
Filter by endpoint.
options.status
string
Filter by delivery status.
options.event_name
string
Filter by event name.
options.limit
number
Max rows per request.
options.cursor
string
Pagination cursor.

Return Value

deliveries
WebhookDeliveriesResponse['data']
Delivery rows.
has_more
boolean
Whether more rows are available.
next_cursor
string | undefined
Cursor for next page.
loading
boolean
Whether request is in progress.
error
unknown
Error from latest request.
refetch
() => void
Revalidate deliveries.

Example

import { useWebhookDeliveries } from "@wacht/react-router";

function DeliveryList() {
  const { deliveries, has_more } = useWebhookDeliveries({ limit: 25 });
  return <div>{deliveries.length} deliveries {has_more ? "(more available)" : ""}</div>;
}