payload-verification-valid-signature-value-template
Overview
This rule belongs to the apimatic-codegen-validation ruleset and states that:
The signatureValueTemplate field must contain the {digest} placeholder to insert the computed digest. If no value is specified, '{digest}' is used as the default.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Payload verification signatureValueTemplate is missing required {digest} placeholder. |
| Code | APIMATICCODEGEN_V531 |
| 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 callback payload verification signature value template template validation digest placeholder |
Suggested Fixes
- Include the {digest} placeholder in the signatureValueTemplate.
- Examples: '{digest}', 'v0={digest}', 'sha256={digest}', 'custom={digest}'.
- The {digest} placeholder will be replaced with the computed signature digest.
- Remove the signatureValueTemplate field to use the default value '{digest}'.
- You can add prefixes or suffixes around {digest} but the placeholder is required.