## Query Webhook Configs

**get** `/api/v2/webhook-configs`

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

### Query Parameters

- `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

- `page_token: optional string`

  Cursor from the previous page's `next_page_token`.

- `project_id: optional string`

### Cookie Parameters

- `session: optional string`

### Returns

- `items: array of WebhookConfigResponse`

  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.

    - `"project"`

  - `webhook_url: string`

    URL that receives webhook POST notifications.

  - `created_at: optional string`

    Creation datetime

  - `updated_at: optional string`

    Update datetime

  - `webhook_events: optional array of "batch.cancelled" or "batch.error" or "batch.pending" or 35 more`

    Subscribed events (null = all events).

    - `"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.

    - `"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.

### Example

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

#### Response

```json
{
  "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
}
```