Skip to main content

callback-url-expression-validation

Overview

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

The callback URL expression must be valid and reference an existing string-type property. Callback URLs can be specified as runtime expressions (pointers), relative URLs, or absolute URLs, but any referenced properties must exist and be of string type.

PropertyValue
EnabledYes
Maximum SeverityError
MessageCallback URL expression is invalid or references invalid property.
CodeAPIMATICCODEGEN_V534
TypeValidation
Rule SystemSemantic
Broad CategoryWebhooks
Products ImpactedCode Generation, Developer Experience Portal
Tagsapimatic code generation codegen sdks portal docs validation apimatic callback url expression runtime expression property validation string type url format

Suggested Fixes

  • Ensure the URL expression uses valid runtime expression syntax if using pointers (for example {$request.body#/callbackUrl}).
  • Verify that any property referenced in the expression exists in the request schema.
  • Confirm that referenced properties are of string type to contain valid URL values.
  • Absolute URLs should include protocol (http/https) and valid domain.
  • Relative URLs should be properly formatted relative paths.
  • Check for typos in property paths and expression syntax.

For More Information