Skip to main content

callback-only-post-method-allowed

Overview

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

Callbacks must use only the POST HTTP method. Other HTTP methods like PUT, GET, or DELETE aren't supported for callback operations.

PropertyValue
EnabledYes
Maximum SeverityError
MessageCallback uses unsupported HTTP method.
CodeAPIMATICCODEGEN_V541
TypeValidation
Rule SystemSemantic
Broad CategoryWebhooks
Products ImpactedCode Generation, Developer Experience Portal
Tagsapimatic code generation codegen sdks portal docs validation apimatic callback http method post method method validation

Suggested Fixes

  • Change the callback HTTP method to POST.
  • Callbacks are outbound notifications and conventionally use POST method only.
  • If you need different HTTP methods, consider using regular API endpoints instead of callbacks.
  • Remove any non-POST operations from the callback definition.

For More Information