Skip to main content

webhook-missing-request-body

Overview

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

Webhooks typically require a request body parameter to receive event data from external services. A missing request body may indicate incomplete webhook configuration or prevent proper event handling.

PropertyValue
EnabledYes
Maximum SeverityWarning
MessageWebhook removed as it doesn't have a request body parameter.
CodeAPIMATICCODEGEN_V537
TypeValidation
Rule SystemSemantic
Broad CategoryWebhooks
Products ImpactedCode Generation, Developer Experience Portal
Tagsapimatic code generation codegen sdks portal docs validation apimatic webhook request body parameter configuration event data

Suggested Fixes

  • Add a request body parameter to the webhook to receive event data.
  • Ensure the request body parameter has ParamFormat.Body format.
  • Define an appropriate schema type for the expected webhook payload.
  • If the webhook intentionally has no body, this warning can be ignored.

For More Information