API Reference

Webhook Configs

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Webhook Configs

GET/api/v1/beta/webhook-configs

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

Query ParametersExpand Collapse

organization_id: optional string

project_id: optional string

Cookie ParametersExpand Collapse

session: optional string

ReturnsExpand Collapse

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

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"

List Webhook Configs

HTTP

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

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

200 example

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

Returns Examples

200 example

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