NotificationProfileResponse
Fields
Section titled “Fields”| 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 |
id |
string (uuid) | Yes | |
revision |
integer | Yes | minimum 1.0 |
health |
NotificationProfileHealth | Yes | |
secretHealth |
VaultReferenceHealth or null | Yes | |
latestSuccessAt |
string (date-time) or null | Yes | |
latestFailureAt |
string (date-time) or null | Yes | |
lastErrorCode |
string or null | Yes | |
createdAt |
string (date-time) | Yes | |
updatedAt |
string (date-time) | Yes |
Additional properties are rejected by this schema.
JSON schema
Section titled “JSON 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 }, "id": { "type": "string", "format": "uuid", "title": "Id" }, "revision": { "type": "integer", "minimum": 1.0, "title": "Revision" }, "health": { "$ref": "#/components/schemas/NotificationProfileHealth" }, "secretHealth": { "anyOf": [ { "$ref": "#/components/schemas/VaultReferenceHealth" }, { "type": "null" } ] }, "latestSuccessAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Latestsuccessat" }, "latestFailureAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Latestfailureat" }, "lastErrorCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lasterrorcode" }, "createdAt": { "type": "string", "format": "date-time", "title": "Createdat" }, "updatedAt": { "type": "string", "format": "date-time", "title": "Updatedat" } }, "additionalProperties": false, "type": "object", "required": [ "name", "configuration", "id", "revision", "health", "secretHealth", "latestSuccessAt", "latestFailureAt", "lastErrorCode", "createdAt", "updatedAt" ], "title": "NotificationProfileResponse"}