payload-verification-valid-digest-encoding

Overview

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

The digestEncoding field in payload verification must use one of the accepted values: 'hex', 'base64', or 'base64url'. If no value is specified, 'hex' is used as the default.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	Payload verification digestEncoding contains invalid value.
Code	APIMATICCODEGEN_V529
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 digest encoding valid values configuration

Suggested Fixes

• Use only accepted digestEncoding values: 'hex', 'base64', or 'base64url'.
• Remove the digestEncoding field to use the default value 'hex'.
• 'hex' produces lowercase hexadecimal digest (for example a1b2c3...).
• 'base64' produces standard Base64 encoding.
• 'base64url' produces URL-safe Base64 encoding without padding.

For More Information

• https://www.apimatic.io/continuous-code-generation
• https://docs.apimatic.io/rulesets/overview/