API Reference

Webhook Configs

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Query Webhook Configs

WebhookConfigListPaginatedPage webhookConfigs().listPaginated(WebhookConfigListPaginatedParamsparams = WebhookConfigListPaginatedParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/api/v2/webhook-configs

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

ParametersExpand Collapse

WebhookConfigListPaginatedParams params

Optional<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.

Optional<String> organizationId

Optional<Long> pageSize

Number of items per page

maximum1000

minimum1

Optional<String> pageToken

Cursor from the previous page’s next_page_token.

Optional<String> projectId

ReturnsExpand Collapse

class WebhookConfigResponse:

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

String id

Unique identifier for the webhook configuration.

boolean hasSecret

Whether a signing secret is configured for this endpoint.

String tenantId

Owner tenant ID.

JsonValue; tenantType "project"constant"project"constant

Owner tenant type.

String webhookUrl

URL that receives webhook POST notifications.

Optional<LocalDateTime> createdAt

Creation datetime

formatdate-time

Optional<LocalDateTime> updatedAt

Update datetime

formatdate-time

Optional<List<WebhookEvent>> webhookEvents

Subscribed events (null = all events).

One of the following:

BATCH_CANCELLED("batch.cancelled")

BATCH_ERROR("batch.error")

BATCH_PENDING("batch.pending")

BATCH_RUNNING("batch.running")

BATCH_SUCCESS("batch.success")

CLASSIFY_CANCELLED("classify.cancelled")

CLASSIFY_ERROR("classify.error")

CLASSIFY_PARTIAL_SUCCESS("classify.partial_success")

CLASSIFY_PENDING("classify.pending")

CLASSIFY_RUNNING("classify.running")

CLASSIFY_SUCCESS("classify.success")

EXTRACT_CANCELLED("extract.cancelled")

EXTRACT_ERROR("extract.error")

EXTRACT_PARTIAL_SUCCESS("extract.partial_success")

EXTRACT_PENDING("extract.pending")

EXTRACT_SUCCESS("extract.success")

PARSE_CANCELLED("parse.cancelled")

PARSE_ERROR("parse.error")

PARSE_PARTIAL_SUCCESS("parse.partial_success")

PARSE_PENDING("parse.pending")

PARSE_RUNNING("parse.running")

PARSE_SUCCESS("parse.success")

SHEETS_CANCELLED("sheets.cancelled")

SHEETS_ERROR("sheets.error")

SHEETS_PARTIAL_SUCCESS("sheets.partial_success")

SHEETS_PENDING("sheets.pending")

SHEETS_SUCCESS("sheets.success")

SPLIT_CANCELLED("split.cancelled")

SPLIT_ERROR("split.error")

SPLIT_PENDING("split.pending")

SPLIT_PROCESSING("split.processing")

SPLIT_SUCCESS("split.success")

UNMAPPED_EVENT("unmapped_event")

VERIFY_CANCELLED("verify.cancelled")

VERIFY_ERROR("verify.error")

VERIFY_PENDING("verify.pending")

VERIFY_RUNNING("verify.running")

VERIFY_SUCCESS("verify.success")

Optional<WebhookHeaders> webhookHeaders

Custom HTTP headers sent with each request.

Optional<WebhookOutputFormat> webhookOutputFormat

Response format sent to the webhook.

One of the following:

JSON("json")

STRING("string")

Query Webhook Configs

Java

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

package ai.llamaindex.llamacloud.example;

import ai.llamaindex.llamacloud.client.LlamaCloudClient;
import ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;
import ai.llamaindex.llamacloud.models.webhookconfigs.WebhookConfigListPaginatedPage;
import ai.llamaindex.llamacloud.models.webhookconfigs.WebhookConfigListPaginatedParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();

        WebhookConfigListPaginatedPage page = client.webhookConfigs().listPaginated();
    }
}

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
}