API Reference

Webhook Configs

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Webhook Config

client.webhookConfigs.retrieve(stringconfigID, WebhookConfigRetrieveParams { organization_id, project_id } query?, RequestOptionsoptions?): WebhookConfigResponse { id, has_secret, tenant_id, 7 more }

GET/api/v1/beta/webhook-configs/{config_id}

Get a single webhook configuration by ID.

ParametersExpand Collapse

configID: string

query: WebhookConfigRetrieveParams { organization_id, project_id }

organization_id?: string | null

project_id?: string | null

ReturnsExpand Collapse

WebhookConfigResponse { id, has_secret, tenant_id, 7 more }

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

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?: string | null

Creation datetime

formatdate-time

updated_at?: string | null

Update datetime

formatdate-time

webhook_events?: Array<"batch.cancelled" | "batch.error" | "batch.pending" | 30 more> | null

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?: Record<string, string> | null

Custom HTTP headers sent with each request.

webhook_output_format?: "json" | "string" | null

Response format sent to the webhook.

One of the following:

"json"

"string"

Get Webhook Config

TypeScript

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

import LlamaCloud from '@llamaindex/llama-cloud';

const client = new LlamaCloud({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

const webhookConfigResponse = await client.webhookConfigs.retrieve('config_id');

console.log(webhookConfigResponse.id);

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