Skip to content

NotificationProfileBody

Field Type Required Description and constraints
name string Yes minimum length 1. maximum length 128
enabled boolean No default true
configuration WebhookNotificationProfileConfig or GenetecNotificationProfileConfig or SmtpNotificationProfileConfig or EmailNotificationProfileConfig or TelegramNotificationProfileConfig or SmsNotificationProfileConfig or SlackNotificationProfileConfig or TeamsNotificationProfileConfig Yes
secretRef string or null No
allowArtifacts boolean No default false

Additional properties are rejected by this schema.

{
"properties": {
"name": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"title": "Name"
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"default": true
},
"configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/WebhookNotificationProfileConfig"
},
{
"$ref": "#/components/schemas/GenetecNotificationProfileConfig"
},
{
"$ref": "#/components/schemas/SmtpNotificationProfileConfig"
},
{
"$ref": "#/components/schemas/EmailNotificationProfileConfig"
},
{
"$ref": "#/components/schemas/TelegramNotificationProfileConfig"
},
{
"$ref": "#/components/schemas/SmsNotificationProfileConfig"
},
{
"$ref": "#/components/schemas/SlackNotificationProfileConfig"
},
{
"$ref": "#/components/schemas/TeamsNotificationProfileConfig"
}
],
"title": "Configuration",
"discriminator": {
"propertyName": "kind",
"mapping": {
"email": "#/components/schemas/EmailNotificationProfileConfig",
"genetec": "#/components/schemas/GenetecNotificationProfileConfig",
"slack": "#/components/schemas/SlackNotificationProfileConfig",
"sms": "#/components/schemas/SmsNotificationProfileConfig",
"smtp": "#/components/schemas/SmtpNotificationProfileConfig",
"teams": "#/components/schemas/TeamsNotificationProfileConfig",
"telegram": "#/components/schemas/TelegramNotificationProfileConfig",
"webhook": "#/components/schemas/WebhookNotificationProfileConfig"
}
}
},
"secretRef": {
"anyOf": [
{
"type": "string",
"maxLength": 128,
"minLength": 1,
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*$"
},
{
"type": "null"
}
],
"title": "Secretref"
},
"allowArtifacts": {
"type": "boolean",
"title": "Allowartifacts",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"configuration"
],
"title": "NotificationProfileBody"
}
Image preview