API Reference

Webhook Configs

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Query Webhook Configs

client.WebhookConfigs.ListPaginated(ctx, query) (*PaginatedCursor[WebhookConfigResponse], error)

GET/api/v2/webhook-configs

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

ParametersExpand Collapse

query WebhookConfigListPaginatedParams

IncludeTotal param.Field[bool]Optional

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.

OrganizationID param.Field[string]Optional

PageSize param.Field[int64]Optional

Number of items per page

maximum1000

minimum1

PageToken param.Field[string]Optional

Cursor from the previous page’s next_page_token.

ProjectID param.Field[string]Optional

ReturnsExpand Collapse

type WebhookConfigResponse struct{…}

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

ID string

Unique identifier for the webhook configuration.

HasSecret bool

Whether a signing secret is configured for this endpoint.

TenantID string

Owner tenant ID.

TenantType Project

Owner tenant type.

WebhookURL string

URL that receives webhook POST notifications.

CreatedAt TimeOptional

Creation datetime

formatdate-time

UpdatedAt TimeOptional

Update datetime

formatdate-time

WebhookEvents []stringOptional

Subscribed events (null = all events).

One of the following:

const WebhookConfigResponseWebhookEventBatchCancelled WebhookConfigResponseWebhookEvent = "batch.cancelled"

const WebhookConfigResponseWebhookEventBatchError WebhookConfigResponseWebhookEvent = "batch.error"

const WebhookConfigResponseWebhookEventBatchPending WebhookConfigResponseWebhookEvent = "batch.pending"

const WebhookConfigResponseWebhookEventBatchRunning WebhookConfigResponseWebhookEvent = "batch.running"

const WebhookConfigResponseWebhookEventBatchSuccess WebhookConfigResponseWebhookEvent = "batch.success"

const WebhookConfigResponseWebhookEventClassifyCancelled WebhookConfigResponseWebhookEvent = "classify.cancelled"

const WebhookConfigResponseWebhookEventClassifyError WebhookConfigResponseWebhookEvent = "classify.error"

const WebhookConfigResponseWebhookEventClassifyPartialSuccess WebhookConfigResponseWebhookEvent = "classify.partial_success"

const WebhookConfigResponseWebhookEventClassifyPending WebhookConfigResponseWebhookEvent = "classify.pending"

const WebhookConfigResponseWebhookEventClassifyRunning WebhookConfigResponseWebhookEvent = "classify.running"

const WebhookConfigResponseWebhookEventClassifySuccess WebhookConfigResponseWebhookEvent = "classify.success"

const WebhookConfigResponseWebhookEventExtractCancelled WebhookConfigResponseWebhookEvent = "extract.cancelled"

const WebhookConfigResponseWebhookEventExtractError WebhookConfigResponseWebhookEvent = "extract.error"

const WebhookConfigResponseWebhookEventExtractPartialSuccess WebhookConfigResponseWebhookEvent = "extract.partial_success"

const WebhookConfigResponseWebhookEventExtractPending WebhookConfigResponseWebhookEvent = "extract.pending"

const WebhookConfigResponseWebhookEventExtractSuccess WebhookConfigResponseWebhookEvent = "extract.success"

const WebhookConfigResponseWebhookEventParseCancelled WebhookConfigResponseWebhookEvent = "parse.cancelled"

const WebhookConfigResponseWebhookEventParseError WebhookConfigResponseWebhookEvent = "parse.error"

const WebhookConfigResponseWebhookEventParsePartialSuccess WebhookConfigResponseWebhookEvent = "parse.partial_success"

const WebhookConfigResponseWebhookEventParsePending WebhookConfigResponseWebhookEvent = "parse.pending"

const WebhookConfigResponseWebhookEventParseRunning WebhookConfigResponseWebhookEvent = "parse.running"

const WebhookConfigResponseWebhookEventParseSuccess WebhookConfigResponseWebhookEvent = "parse.success"

const WebhookConfigResponseWebhookEventSheetsCancelled WebhookConfigResponseWebhookEvent = "sheets.cancelled"

const WebhookConfigResponseWebhookEventSheetsError WebhookConfigResponseWebhookEvent = "sheets.error"

const WebhookConfigResponseWebhookEventSheetsPartialSuccess WebhookConfigResponseWebhookEvent = "sheets.partial_success"

const WebhookConfigResponseWebhookEventSheetsPending WebhookConfigResponseWebhookEvent = "sheets.pending"

const WebhookConfigResponseWebhookEventSheetsSuccess WebhookConfigResponseWebhookEvent = "sheets.success"

const WebhookConfigResponseWebhookEventSplitCancelled WebhookConfigResponseWebhookEvent = "split.cancelled"

const WebhookConfigResponseWebhookEventSplitError WebhookConfigResponseWebhookEvent = "split.error"

const WebhookConfigResponseWebhookEventSplitPending WebhookConfigResponseWebhookEvent = "split.pending"

const WebhookConfigResponseWebhookEventSplitProcessing WebhookConfigResponseWebhookEvent = "split.processing"

const WebhookConfigResponseWebhookEventSplitSuccess WebhookConfigResponseWebhookEvent = "split.success"

const WebhookConfigResponseWebhookEventUnmappedEvent WebhookConfigResponseWebhookEvent = "unmapped_event"

const WebhookConfigResponseWebhookEventVerifyCancelled WebhookConfigResponseWebhookEvent = "verify.cancelled"

const WebhookConfigResponseWebhookEventVerifyError WebhookConfigResponseWebhookEvent = "verify.error"

const WebhookConfigResponseWebhookEventVerifyPending WebhookConfigResponseWebhookEvent = "verify.pending"

const WebhookConfigResponseWebhookEventVerifyRunning WebhookConfigResponseWebhookEvent = "verify.running"

const WebhookConfigResponseWebhookEventVerifySuccess WebhookConfigResponseWebhookEvent = "verify.success"

WebhookHeaders map[string, string]Optional

Custom HTTP headers sent with each request.

WebhookOutputFormat WebhookConfigResponseWebhookOutputFormatOptional

Response format sent to the webhook.

One of the following:

const WebhookConfigResponseWebhookOutputFormatJson WebhookConfigResponseWebhookOutputFormat = "json"

const WebhookConfigResponseWebhookOutputFormatString WebhookConfigResponseWebhookOutputFormat = "string"

Query Webhook Configs

Go

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

package main

import (
  "context"
  "fmt"

  "github.com/run-llama/llama-parse-go"
  "github.com/run-llama/llama-parse-go/option"
)

func main() {
  client := llamacloud.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.WebhookConfigs.ListPaginated(context.TODO(), llamacloud.WebhookConfigListPaginatedParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

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
}