Installation Validation API

Methods

validateInstallation

A method that runs when a user installs a custom integration or changes the integration's configuration.

Signature

validateInstallation(config) => ValidationResult

Parameters

NameTypeRequiredDescription
configRecord<string, any>YesThe user-provided configuration.

Returns

ValidationResult

Types

ValidationResult

Describes the result of an installation's validation.

Signature

type ValidationResult = {
  isValid: boolean;
  errorMessage: string | null;
};

Properties

NameTypeRequiredDescription
isValidbooleanYesIf true, the installation is valid.
errorMessagestring | nullYesAn error message to show when the installation is not valid.