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.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Warning |
Message | Webhook removed as it doesn't have a request body parameter. |
Code | APIMATICCODEGEN_V537 |
Type | Validation |
Rule System | Semantic |
Broad Category | Webhooks |
Products Impacted | Code Generation, Developer Experience Portal |
Tags | apimatic 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.