Flow JSON enforces strict validation rules to ensure that configurations are correctly structured. One common validation issue developers encounter is the INVALID_PROPERTY_KEY error. This error occurs when an unrecognized or extra property is included in the JSON structure. In this guide, we'll break down why this error happens, how to fix it, and best practices to avoid it.

What is the INVALID_PROPERTY_KEY Error?

Error Code: INVALID_PROPERTY_KEY

Error Message: Property (propertyName) cannot be specified at (errorPath).

When inside a component: Property (propertyName) cannot be specified at (componentName) on (errorPath).

Cause:

  • The specified property is not recognized within the Flow JSON schema.

  • Additional properties that are not explicitly allowed trigger this error.

  • Flow JSON only accepts predefined keys for each component and section.

Example of an Invalid Flow JSON File

{
   "version": "2.1",
   "myNewProp": "hello"
}

Explanation

  • "myNewProp" is not a valid key according to Flow JSON specifications.

  • Only predefined properties are allowed.

  • Any extra or misspelled properties will lead to an INVALID_PROPERTY_KEY error.

How to Fix the INVALID_PROPERTY_KEY Error

To resolve this error, follow these steps:

  1. Check the Allowed Properties: Refer to the official Flow JSON documentation to ensure you're using valid properties.

  2. Remove or Correct Invalid Properties: If a property is incorrect, either remove it or replace it with a valid key.

  3. Validate JSON Before Deployment: Use JSON schema validation tools to detect issues before implementing changes.

Corrected Flow JSON Example

{
   "version": "2.1"
}

Here, the invalid property "myNewProp" has been removed, ensuring schema compliance.

Tip: Use JSON validation tools to catch errors early and always refer to official documentation before adding new properties.

For more insights related to WhatsApp Business API, check out heltar.com/blogs.