Skip to main content

webhook-no-group-assigned-warning

Overview

This rule belongs to the apimatic-codegen-validation ruleset and states that:

This webhook doesn't have an x-webhook-group extension specified. While not required, assigning webhooks to groups enables better organization and discriminator functionality.

PropertyValue
EnabledYes
Maximum SeverityWarning
MessageNo webhook group assigned for this webhook.
CodeAPIMATICCODEGEN_V535
TypeValidation
Rule SystemSemantic
Broad CategoryWebhooks
Products ImpactedCode Generation, Developer Experience Portal
Tagsapimatic code generation codegen sdks portal docs validation apimatic webhook webhook group x-webhook-group organization configuration

Suggested Fixes

  • Add an x-webhook-group extension to explicitly assign the webhook to a group.
  • If no grouping is needed, this warning can be ignored.
  • Webhook groups enable discriminator-based event handling and better organization.
  • Consider creating webhook groups if you have multiple webhook types.

For More Information