> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://buildwithfern.com/learn/llms.txt.

# Generate Webhook Reference

> Use Fern Docs to generate your Webhook Reference documentation from an OpenAPI spec.

Fern generates Webhook Reference documentation from an [OpenAPI specification](/learn/api-definitions/openapi/endpoints/webhooks).

Fern supports webhooks through:

* **OpenAPI 3.1+**: Use the native `webhooks` field with an `operationId` (recommended)
* **OpenAPI 3.0**: Use the `x-fern-webhook: true` extension

## Configuration

#### Set up your project structure

Add your specification file to your `/fern` directory and create a `generators.yml` that references it:

**`generators.yml`**

```yaml generators.yml
api:
  path: openapi/openapi.yml
```

#### Add the Webhook Reference to your navigation

Add `- api: Webhook Reference` to your navigation in `docs.yml`:

**`docs.yml`**

```yml docs.yml
navigation:
  - api: Webhook Reference
    api-name: webhooks-v1
```

Use the `api-name` property to reference the folder containing your webhook definition.

#### Customize the layout

For a full list of configuration options and layout customizations, see [Customize API Reference layout](/learn/docs/api-references/customize-api-reference-layout).

For a real-world example of webhook documentation generated from an API definition, check out [Webflow's webhooks](https://developers.webflow.com/data/reference/webhooks/events/form-submission).

### Include more than one Webhook Reference

To include multiple webhook definitions in your documentation, use the `api-name` property. The `api-name` corresponds to the folder name containing your webhook definition.

**`docs.yml`**

```yaml title="docs.yml"
navigation:
  - api: Payment Webhooks
    api-name: payment-webhooks
  - api: Order Webhooks
    api-name: order-webhooks
```

### Reference individual webhook events

To display each webhook event as an individual page, reference it in the `layout` using the `subpackage_{tag}.{webhook-event-name}` format:

**`docs.yml`**

```yaml title="docs.yml"
navigation:
  - api: Webhook Reference
    api-name: webhooks-v1
    layout:
      - subpackage_plants.newPlantWebhook
```

Where `{tag}` is the first tag (lowercase) and `{webhook-event-name}` is the `operationId` from your webhook definition.

You must have the `tags` and `example` properties defined [in your webhook specification](/learn/api-definitions/openapi/endpoints/webhooks).

> Use Fern Docs to generate your Webhook Reference documentation from an OpenAPI spec.