listWebhookApps()

Returns webhook apps as a paginated result. This endpoint supports limit, offset, and include_inactive.

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 listWebhookApps() {  const client = await wachtClient();  return client.webhooks.listWebhookApps({    limit: 20,    offset: 0,    include_inactive: true,  });}

Signature

function listWebhookApps(  options?: {    limit?: number;    offset?: number;    include_inactive?: boolean;  },): Promise<PaginatedResponse<WebhookApp>>

Parameters

›

limit?: number | undefined;

Maximum number of webhook apps to return for this page.

›

offset?: number | undefined;

Number of webhook apps to skip before returning results.

›

include_inactive?: boolean | undefined;

When `true`, includes inactive apps in the page results.

Return value

›

data?: WebhookApp[] | undefined;

Webhook apps in the current page.

›

deployment_id?: string | undefined;

Deployment that owns the webhook app.

›

app_slug?: string | undefined;

Stable app slug used in webhook app routes.

›

name?: string | undefined;

Display name of the webhook app.

›

description?: string | null | undefined;

Optional webhook app description.

›

signing_secret?: string | undefined;

Current signing secret used for webhook signatures.

›

failure_notification_emails?: string[] | undefined;

Configured notification emails for failed deliveries.

›

event_catalog_slug?: string | null | undefined;

Assigned event catalog slug when one exists.

›

is_active?: boolean | undefined;

Whether the webhook app is active.

›

created_at?: string | undefined;

Creation timestamp.

›

updated_at?: string | undefined;

Last update timestamp.

›

has_more?: boolean | undefined;

Whether another page exists after the current page.

›

limit?: number | undefined;

Effective page size reflected by the backend response.

›

offset?: number | undefined;

Effective offset reflected by the 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 active apps with default pagination

import { wachtClient } from '@wacht/nextjs/server';export async function listActiveWebhookApps() {  const client = await wachtClient();  return client.webhooks.listWebhookApps();}

Fetch one page for admin UI

import { wachtClient } from '@wacht/nextjs/server';export async function listWebhookAppsPage(page: number, pageSize = 25) {  const client = await wachtClient();  return client.webhooks.listWebhookApps({    limit: pageSize,    offset: page * pageSize,    include_inactive: true,  });}