listWebhookDeliveries()

Returns delivery attempts for a webhook app as a paginated list of delivery records.

Usage

The following example shows a basic usage of the backend client from @wacht/nextjs/server.

import { wachtClient } from '@wacht/nextjs/server';export async function listWebhookDeliveries(appSlug: string) {  const client = await wachtClient();  return client.webhooks.listWebhookDeliveries(appSlug, {    limit: 50,    offset: 0,    status: 'failed',    event_name: 'user.created',  });}

Signature

function listWebhookDeliveries(  appSlug: string,  options?: {    limit?: number;    offset?: number;    endpoint_id?: number;    event_name?: string;    status?: string;    since?: string;    until?: string;  },): Promise<PaginatedResponse<WebhookDelivery>>

Parameters

›

appSlug?: string | undefined;

Webhook app slug to scope delivery results.

›

status?: string | undefined;

Optional delivery status filter (for example `failed`, `delivered`, `pending`).

›

event_name?: string | undefined;

Optional event name filter.

›

endpoint_id?: number | undefined;

Optional endpoint id filter.

›

limit?: number | undefined;

Maximum deliveries to return for this page.

›

offset?: number | undefined;

Number of deliveries to skip before returning results.

›

since?: string | undefined;

Optional lower timestamp bound (ISO-8601 string).

›

until?: string | undefined;

Optional upper timestamp bound (ISO-8601 string).

Return value

›

data?: WebhookDelivery[] | undefined;

Delivery rows for the current page.

›

delivery_id?: string | undefined;

Stable delivery identifier.

›

deployment_id?: string | undefined;

Deployment identifier.

›

app_slug?: string | undefined;

Webhook app slug for this delivery.

›

endpoint_id?: string | undefined;

Endpoint identifier that handled the delivery.

›

event_name?: string | undefined;

Delivered event name.

›

status?: string | undefined;

Current delivery status.

›

http_status_code?: number | null | undefined;

HTTP response status code when one exists.

›

response_time_ms?: number | null | undefined;

Measured response time in milliseconds when available.

›

attempt_number?: number | undefined;

Current attempt number for this delivery.

›

max_attempts?: number | undefined;

Maximum allowed attempts for this delivery.

›

timestamp?: string | undefined;

Delivery timestamp.

›

has_more?: boolean | undefined;

Whether another page exists after this one.

›

limit?: number | undefined;

Effective page size reflected by backend response.

›

offset?: number | undefined;

Effective offset reflected by backend response.

Behavior

Returns a backend-scoped list response for this resource.
Use pagination and filters from this method to build admin list views.

Examples

List recent failed deliveries

import { wachtClient } from '@wacht/nextjs/server';export async function listFailedDeliveries(appSlug: string) {  const client = await wachtClient();  return client.webhooks.listWebhookDeliveries(appSlug, {    status: 'failed',    limit: 25,  });}

Paginate deliveries in an admin screen

import { wachtClient } from '@wacht/nextjs/server';export async function listDeliveryPage(appSlug: string, page: number, pageSize = 50) {  const client = await wachtClient();  return client.webhooks.listWebhookDeliveries(appSlug, {    limit: pageSize,    offset: page * pageSize,  });}