webhook-valid-name
Overview
This rule belongs to the apimatic-codegen-validation ruleset and states that:
Webhook names must follow valid naming conventions. Names should contain only alphanumeric characters, underscores, and hyphens, and must not start with numbers or special characters.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Webhook name contains invalid characters or format. |
| Code | APIMATICCODEGEN_V542 |
| 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 naming convention identifier |
Suggested Fixes
- Use only letters, numbers, underscores, and hyphens in webhook names.
- Start webhook names with a letter or underscore, not a number.
- Avoid spaces and special characters like @, #, $, %, etc.
- Use descriptive names that clearly identify the webhook purpose (for example 'paymentStatusUpdated').