Skip to main content

webhook-only-post-method-allowed

Overview

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

Webhooks must use only the POST HTTP method. Other HTTP methods like PUT aren't supported for webhook operations.

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

Suggested Fixes

  • Change the webhook HTTP method to POST.
  • Webhooks are server-initiated notifications and conventionally use POST method only.
  • If you need different HTTP methods, consider using callbacks instead of webhooks.
  • Remove any non-POST operations from the webhook definition.

For More Information