Getting Started with Webhook Documentation
Create your first webhook API documentation in NeoArc Studio. Walk through creating a webhook API directory, configuring the root definition with security and delivery settings, and adding event type definitions with payload schemas.
This guide walks you through creating webhook API documentation from scratch. By the end, you will have a documented webhook API with security verification, delivery configuration, and event type definitions that publish as a browsable reference on your documentation site.
Step 1: Create the Webhook API Directory
Webhook APIs are stored in the Integration Design section of your workspace, alongside REST APIs, GraphQL APIs, and async event APIs.
Step 2: Configure the Root Definition
The root definition captures the API-level settings that apply to all webhook events.
Step 3: Add Event Type Definitions
Each webhook event type is documented as a separate file in the definitions/ subdirectory.
Step 4: Configure Consumer Guidance
The root definition includes a consumer guidance section for documenting integration best practices.
Step 5: Configure Testing and Observability
Help consuming teams validate their integration before going live.