Naming schemes

Learn how naming schemes work for app components during app development and registration.

The Kustomer Apps Platform requires naming schemes for certain app component properties.

When an app component property follows a naming scheme, the naming scheme is listed under the corresponding documentation for the component under the App Object Model section.

While we recommend following these naming schemes during app development, the Kustomer Apps Platform will automatically apply required naming schemes as needed during app registration.

Naming scheme format

App component properties that require a naming scheme must follow the kustomer.app.<appName>.* format, where appName stands in for the main app property from you app definition and * stands in for the component property name.

App registration and naming schemes

During app registration, the Kustomer Apps Platform automatically applies naming schemes as needed and will list any naming scheme updates in the return body of the registration request.

📘

Naming schemes for app versions

The Kustomer Apps Platform automatically handles naming schemes each time you register an app or update the version. This means that you don't need to maintain naming schemes in your local app definition during app development.

Auto-applied naming schemes

The Kustomer Apps Platform automatically applies naming schemes for the following app components when you register an app definition with component properties that don't follow the naming schemes:

App component

Property

Example

Commands

name

"name": "kustomer.app.<appName>.<name>"

Inbound Webhooks

eventName

"eventName": "kustomer.app.<appName>.<eventName>"

Klass Views (KViews)

name

"name": "kustomer.app.<appName>.<name>"

Workflows

steps.action

trigger.eventName

"action": "kustomer.app.<appName>.<action>"

"eventName": "kustomer.app.<appName>.<eventName>"

Workflow Actions

name

"name": "kustomer.app.<appName>.<name>"

Workflow Triggers

eventName

"eventName": "kustomer.app.<appName>.<eventName>"


Did this page help you?