Generate Webhook Reference

Fern generates Webhook Reference documentation from an OpenAPI specification.

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

1
api:
2
  path: openapi/openapi.yml

1
navigation:
2
  - api: Webhook Reference
3
    api-name: webhooks-v1

For a real-world example of webhook documentation generated from an API definition, check out Webflow’s webhooks.

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.

1
navigation:
2
  - api: Payment Webhooks
3
    api-name: payment-webhooks
4
  - api: Order Webhooks
5
    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:

1
navigation:
2
  - api: Webhook Reference
3
    api-name: webhooks-v1
4
    layout:
5
      - subpackage_plants.newPlantWebhook

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