> ## Documentation Index
> Fetch the complete documentation index at: https://docs.r28.ai/charter/llms.txt
> Use this file to discover all available pages before exploring further.

# Objects

> Every object and enum the Batch tools accept.

## Model tree

<div className="model-tree"><div className="model-tree-scroll"><div className="tree-node"><a href="#webhook">Webhook</a></div></div></div>

## Webhook

Webhook specification for crawl or batch scrape jobs.

<div className="reference-table">
  | Field                                                       | Type                             | Description                                                                                             |
  | ----------------------------------------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------- |
  | `url` <span className="required" title="required">\*</span> | `string`                         | The URL to send the webhook to.                                                                         |
  | `headers`                                                   | map of `string`                  | Headers to send to the webhook URL.                                                                     |
  | `metadata`                                                  | `object`                         | Custom metadata that will be included in all webhook payloads.                                          |
  | `events`                                                    | [WebhookEvent](#webhookevent)\[] | Type of events that should be sent to the webhook URL. The server sends all events when this is absent. |
</div>

## WebhookEvent

<div className="enum-table">
  | Value       |
  | ----------- |
  | `completed` |
  | `page`      |
  | `failed`    |
  | `started`   |
</div>
