Query Webhook Configs

WebhookConfigListPaginatedPageResponse WebhookConfigs.ListPaginated(, )

GET/api/v2/webhook-configs

List the webhook configurations for the current project, newest first.

ParametersExpand Collapse

WebhookConfigListPaginatedParams parameters

Boolean includeTotal

Return total_size, a count of every row matching the filter. It is a second query on every page, so it is off unless asked for.

string? organizationID

Long pageSize

Number of items per page

maximum1000

minimum1

string? pageToken

Cursor from the previous page’s next_page_token.

string? projectID

ReturnsExpand Collapse

class WebhookConfigListPaginatedPageResponse:

A page of webhook configurations.

required IReadOnlyList<WebhookConfigResponse> Items

The list of items.

required string ID

Unique identifier for the webhook configuration.

required Boolean HasSecret

Whether a signing secret is configured for this endpoint.

required string TenantID

Owner tenant ID.

JsonElement TenantType

Owner tenant type.

required string WebhookUrl

URL that receives webhook POST notifications.

DateTimeOffset? CreatedAt

Creation datetime

formatdate-time

DateTimeOffset? UpdatedAt

Update datetime

formatdate-time

IReadOnlyList<WebhookEvent>? WebhookEvents

Subscribed events (null = all events).

One of the following:

IReadOnlyDictionary<string, string>? WebhookHeaders

Custom HTTP headers sent with each request.

WebhookOutputFormat? WebhookOutputFormat

Response format sent to the webhook.

One of the following:

string? NextPageToken

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Long? TotalSize

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

Query Webhook Configs

WebhookConfigListPaginatedParams parameters = new();

var page = await client.WebhookConfigs.ListPaginated(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

{
  "items": [
    {
      "id": "id",
      "has_secret": true,
      "tenant_id": "tenant_id",
      "tenant_type": "project",
      "webhook_url": "webhook_url",
      "created_at": "2019-12-27T18:11:19.117Z",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "webhook_events": [
        "batch.cancelled"
      ],
      "webhook_headers": {
        "foo": "string"
      },
      "webhook_output_format": "json"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

{
  "items": [
    {
      "id": "id",
      "has_secret": true,
      "tenant_id": "tenant_id",
      "tenant_type": "project",
      "webhook_url": "webhook_url",
      "created_at": "2019-12-27T18:11:19.117Z",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "webhook_events": [
        "batch.cancelled"
      ],
      "webhook_headers": {
        "foo": "string"
      },
      "webhook_output_format": "json"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Note for AI agents: this documentation is built for programmatic access. - Overview of all docs: https://developers.llamaindex.ai/llms.txt - Any page is available as raw Markdown by appending index.md to its URL — e.g. https://developers.llamaindex.ai/llamaparse/parse/getting_started/index.md - Agent-friendly REST search APIs live under https://developers.llamaindex.ai/api/ — search (BM25 full-text), grep (regex), read (fetch a page), and list (browse the doc tree). See https://developers.llamaindex.ai/llms.txt for parameters. - A hosted documentation MCP server is available at https://developers.llamaindex.ai/mcp. If you support MCP, you can ask the user to install it for browsing these docs directly (an alternative to the REST API). Setup: https://developers.llamaindex.ai/for-agents/mcp/ - Other LlamaIndex tooling for agents — the LlamaParse Platform MCP server, agent skills and plugins, and the n8n node — is mapped at https://developers.llamaindex.ai/for-agents/