API Reference

Webhook Configs

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Query Webhook Configs

GET/api/v2/webhook-configs

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

Query ParametersExpand Collapse

include_total: optional boolean

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 string

page_size: optional number

Number of items per page

maximum1000

minimum1

page_token: optional string

Cursor from the previous page’s next_page_token.

project_id: optional string

Cookie ParametersExpand Collapse

session: optional string

ReturnsExpand Collapse

items: array of WebhookConfigResponse { id, has_secret, tenant_id, 7 more }

The list of items.

id: string

Unique identifier for the webhook configuration.

has_secret: boolean

Whether a signing secret is configured for this endpoint.

tenant_id: string

Owner tenant ID.

tenant_type: "project"

Owner tenant type.

webhook_url: string

URL that receives webhook POST notifications.

created_at: optional string

Creation datetime

formatdate-time

updated_at: optional string

Update datetime

formatdate-time

webhook_events: optional array of "batch.cancelled" or "batch.error" or "batch.pending" or 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 map[string]

Custom HTTP headers sent with each request.

webhook_output_format: optional "json" or "string"

Response format sent to the webhook.

One of the following:

"json"

"string"

next_page_token: optional string

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

total_size: optional number

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

HTTP

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

curl https://api.cloud.llamaindex.ai/api/v2/webhook-configs \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"

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
}