API Reference

Webhook Configs

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Query Webhook Configs

webhook_configs.list_paginated(WebhookConfigListPaginatedParams**kwargs) -> SyncPaginatedCursor[WebhookConfigResponse]

GET/api/v2/webhook-configs

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

ParametersExpand Collapse

include_total: Optional[bool]

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.

organization_id: Optional[str]

page_size: Optional[int]

Number of items per page

maximum1000

minimum1

page_token: Optional[str]

Cursor from the previous page’s next_page_token.

project_id: Optional[str]

ReturnsExpand Collapse

class WebhookConfigResponse: …

A stored webhook configuration. The signing secret is never included.

id: str

Unique identifier for the webhook configuration.

has_secret: bool

Whether a signing secret is configured for this endpoint.

tenant_id: str

Owner tenant ID.

tenant_type: Literal["project"]

Owner tenant type.

webhook_url: str

URL that receives webhook POST notifications.

created_at: Optional[datetime]

Creation datetime

formatdate-time

updated_at: Optional[datetime]

Update datetime

formatdate-time

webhook_events: Optional[List[Literal["batch.cancelled", "batch.error", "batch.pending", 35 more]]]

Subscribed events (null = all events).

One of the following:

"batch.cancelled"

"batch.error"

"batch.pending"

"batch.running"

"batch.success"

"classify.cancelled"

"classify.error"

"classify.partial_success"

"classify.pending"

"classify.running"

"classify.success"

"extract.cancelled"

"extract.error"

"extract.partial_success"

"extract.pending"

"extract.success"

"parse.cancelled"

"parse.error"

"parse.partial_success"

"parse.pending"

"parse.running"

"parse.success"

"sheets.cancelled"

"sheets.error"

"sheets.partial_success"

"sheets.pending"

"sheets.success"

"split.cancelled"

"split.error"

"split.pending"

"split.processing"

"split.success"

"unmapped_event"

"verify.cancelled"

"verify.error"

"verify.pending"

"verify.running"

"verify.success"

webhook_headers: Optional[Dict[str, str]]

Custom HTTP headers sent with each request.

webhook_output_format: Optional[Literal["json", "string"]]

Response format sent to the webhook.

One of the following:

"json"

"string"

Query Webhook Configs

Python

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

import os
from llama_cloud import LlamaCloud

client = LlamaCloud(
    api_key=os.environ.get("LLAMA_CLOUD_API_KEY"),  # This is the default and can be omitted
)
page = client.webhook_configs.list_paginated()
page = page.items[0]
print(page.id)

200 example

{
  "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

200 example

{
  "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
}