Organize Your Portal Sidebar with Webhook and Callback Groups

Managing event-driven APIs just got simpler. The Developer Portal now lets you include all webhooks or callbacks from a group directly in toc.yml with a single webhook-group or callback-group entry — no more listing every event by hand.

What's New?

Instead of enumerating every individual webhook and callback, you can now point to an entire group with a single generate entry. Set from: webhook-group or from: callback-group, and every event belonging to that group in your API specification is pulled in automatically.

Manual Configuration

  - group: Ordering Events
    items:
      - group: Callbacks
        items:
          - group: Payment Callbacks
            items:
              - generate:
                from: callback-group-overview
                callback-group: paymentCallbacks
              - generate:
                from: callback
                callback-name: fulfillmentCallback
                callback-group: paymentCallbacks
      - group: Webhooks
        items:
          - group: Notification Events
            items:
              - generate:
                from: webhook-group-overview
                webhook-group: notificationEvents
              - generate:
                from: webhook
                webhook-name: userNotificationEvent
                webhook-group: notificationEvents
              - generate:
                from: webhook
                webhook-name: systemNotificationEvent
                webhook-group: notificationEvents
              - generate:
                from: webhook
                webhook-name: inventoryChangeEvent
                webhook-group: notificationEvents
          - group: Status Events
            items:
              - generate:
                from: webhook-group-overview
                webhook-group: statusEvents
              - generate:
                from: webhook
                webhook-name: paymentStatusUpdated
                webhook-group: statusEvents
              - generate:
                from: webhook
                webhook-name: paymentStatusCreated
                webhook-group: statusEvents

Webhook & Callback Group Reference

toc:
  - group: Ordering Events
    items:
      - group: Callbacks
        items:
          - generate: Payment Callbacks
            from: callback-group
            callback-group: paymentCallbacks
      - group: Webhooks
        items:
          - generate: Notification Events
            from: webhook-group
            webhook-group: notificationEvents
          - generate: Status Events
            from: webhook-group
            webhook-group: statusEvents

The result is a leaner toc.yml that stays accurate as your API specification evolves.

With this change, you no longer need to manually maintain:

• Individual webhook or callback entries
• Separate group overview pages
• Repeated webhook-name or callback-name fields for every event

Benefits

• Cut down on boilerplate configuration in toc.yml
• Keep your portal sidebar automatically in sync with the API specification
• Reduce maintenance overhead when events are added, renamed, or removed
• Achieve cleaner sidebar organization with less effort

For full configuration details, see this documentation.