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

# EventField

Field definition block for webhook and event payloads, including nested object paths, requirement markers, and payload locations.

**Interactive playground** For isolated previews, theme switching, and sandbox editing, open [the EventField playground on holydocs.com](https://holydocs.com/components/event-field).

## When to use

Use this component when endpoint documentation needs explicit request, response, schema, or lifecycle metadata.

## Live Examples

Every example below renders the real component directly inside HolyDocs, followed by the exact MDX you can paste into a page.

### Signature Header

Standalone event field for a webhook header.

**x-holydocs-signature**

HMAC signature of the raw request body. Verify this before parsing the payload.

~~~mdx
<EventField name="x-holydocs-signature" type="string" location="header" required>
HMAC signature of the raw request body. Verify this before parsing the payload.
</EventField>
~~~

## Props

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `name` | `string` | `field` | Field path or name inside the event payload. |
| `type` | `string` | `string` | Field type. |
| `location` | `string` | `payload` | Where the field lives, such as payload or header. |
| `required` | `boolean` | `false` | Marks the field as required. |

## Usage

Start from this baseline shape and then tailor the copy, data, or nesting to the page you are writing.

~~~mdx
<EventField name="x-holydocs-signature" type="string" location="header" required>
HMAC signature of the raw request body. Verify this before parsing the payload.
</EventField>
~~~

## Tips

- Keep naming and ordering consistent across fields, examples, and lifecycle notes so readers do not have to re-parse the endpoint surface on every page.
- Document the happy path and the sharp edges together. Request shape alone is not enough without auth, errors, and retry guidance.
- If a component renders into the right panel, verify the page on desktop width so you can confirm the supporting example is visible where readers expect it.

## Related Components

**[ParamField](/components/param-field)**

Documents a request parameter — path, query, or body — with type, requirement status, and description.
**[ResponseField](/components/response-field)**

Documents a field in an API response body with its name, type, and description.
**[Expandable](/components/expandable)**

Collapsible section for nested API fields, keeping complex response shapes readable.

## More

- Interactive playground: [EventField on holydocs.com](https://holydocs.com/components/event-field)
- Component library index: [/components](/components)