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.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Error |
Message | Callback URL expression is invalid or references invalid property. |
Code | APIMATICCODEGEN_V534 |
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 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.