Объект способа оповещения

Следующие объекты непосредственно связаны с API mediatype.

Тип оповещения

Объект типа оповещения имеет следующие свойства.

Property Type Description
mediatypeid ID ID типа оповещения.

Поведение свойства:
- только для чтения
- обязательно для операций обновления
name string Имя типа оповещения.

Поведение свойства:
- обязательно для операций создания
type integer Транспорт, используемый типом оповещения.

Возможные значения:
0 - Email;
1 - Script;
2 - SMS;
4 - Webhook.

Поведение свойства:
- обязательно для операций создания
exec_path string Имя файла сценария (например, notification.sh), расположенного в каталоге, указанном в параметре конфигурации сервера AlertScriptsPath.

Поведение свойства:
- обязательно если type установлено в "Script"
gsm_modem string Имя последовательного устройства GSM-модема.

Поведение свойства:
- обязательно если type установлено в "SMS"
passwd string Пароль аутентификации.

Поведение свойства:
- поддерживается если smtp_authentication установлено в "Normal password"
provider integer Почтовый провайдер.

Возможные значения:
0 - (по умолчанию) Generic SMTP;
1 - Gmail;
2 - Gmail relay;
3 - Office365;
4 - Office365 relay.
smtp_email string Адрес электронной почты, с которого будут отправляться уведомления.

Поведение свойства:
- обязательно если type установлено в "Email"
smtp_helo string SMTP HELO.

Поведение свойства:
- поддерживается если type установлено в "Email"
smtp_server string SMTP server.

Поведение свойства:
- обязательно если type установлено в "Email"
smtp_port integer Порт SMTP server, к которому выполняется подключение.

По умолчанию: 25.

Поведение свойства:
- поддерживается если type установлено в "Email"
smtp_security integer Уровень безопасности SMTP-соединения.

Возможные значения:
0 - (по умолчанию) Нет;
1 - STARTTLS;
2 - SSL/TLS.

Поведение свойства:
- поддерживается если type установлено в "Email"
smtp_verify_host integer Проверка SSL host для SMTP.

Возможные значения:
0 - (по умолчанию) Нет;
1 - Да.

Поведение свойства:
- поддерживается если smtp_security установлено в "STARTTLS" или "SSL/TLS"
smtp_verify_peer integer Проверка SSL peer для SMTP.

Возможные значения:
0 - (по умолчанию) Нет;
1 - Да.

Поведение свойства:
- поддерживается если smtp_security установлено в "STARTTLS" или "SSL/TLS"
smtp_authentication integer Метод SMTP-аутентификации.

Возможные значения:
0 - (по умолчанию) Нет;
1 - Normal password;
2 - OAuth token.
OAuth-аутентификация не разрешена для почтового провайдера Office365 relay.

Поведение свойства:
- поддерживается если type установлено в "Email"
redirection_url string URL веб-интерфейса Zabbix для перенаправления после OAuth-авторизации.

По умолчанию:
Значение свойства API settings url с частью zabbix.php?action=oauth.authorize

Поведение свойства:
- обязательно если smtp_authentication установлено в "OAuth token"
client_id string Идентификатор клиента, зарегистрированный на сервере авторизации OAuth.

Поведение свойства:
- обязательно если smtp_authentication установлено в "OAuth token"
client_secret string Секрет клиента, зарегистрированный на сервере авторизации OAuth. Доступен только пользователю типа Super Admin.

Поведение свойства:
- обязательно если smtp_authentication установлено в "OAuth token"
authorization_url string URL OAuth с параметрами для получения токенов доступа и обновления.

Поведение свойства:
- обязательно если smtp_authentication установлено в "OAuth token"
token_url string URL OAuth для обмена токена авторизации на токены доступа и обновления.
Этот URL также используется сервером для обновления недействительного токена доступа.

Поведение свойства:
- обязательно если smtp_authentication установлено в "OAuth token"
tokens_status integer Битовая маска состояния токенов.

Возможные значения:
0 - (по умолчанию) Оба токена содержат недопустимое значение
1 - Токен доступа содержит допустимое значение
2 - Токен обновления содержит допустимое значение
3 - Оба токена содержат допустимое значение.

Поведение свойства:
- поддерживается если smtp_authentication установлено в "OAuth token"
access_token string Значение токена доступа OAuth.

Поведение свойства:
- обязательно если smtp_authentication установлено в "OAuth token"
access_token_updated timestamp Метка времени последнего изменения access_token, выполненного сервером при обновлении с помощью refresh_token или API при изменении токена.

Поведение свойства:
- поддерживается если smtp_authentication установлено в "OAuth token"
access_expires_in integer Время в секундах, через которое access_token станет устаревшим и потребуется выполнить запрос к refresh_url.
Устанавливается сервером Zabbix при обновлении access_token или API при изменении токена.

Метка времени вычисляется путем добавления значения access_token_updated.

Поведение свойства:
- поддерживается если smtp_authentication установлено в "OAuth token"
refresh_token string Значение токена обновления OAuth.

Поведение свойства:
- обязательно если smtp_authentication установлено в "OAuth token"
status integer Включен ли тип оповещения.

Возможные значения:
0 - (по умолчанию) Включен;
1 - Отключен.
username string Имя пользователя.

Поведение свойства:
- поддерживается если smtp_authentication установлено в "Normal password"
maxsessions integer Максимальное число оповещений, которые могут обрабатываться параллельно.

Возможные значения, если type установлено в "SMS": 1.

Возможные значения, если type установлено в "Email", "Script" или "Webhook": 0-100.

По умолчанию: 1.
maxattempts integer Максимальное число попыток отправки оповещения.

Возможные значения: 1-100.

По умолчанию: 3.
attempt_interval string Интервал между повторными попытками.
Принимает секунды и единицу времени с суффиксом.

Возможные значения: 0-1h.

По умолчанию: 10s.
message_format integer Формат сообщения.

Возможные значения:
0 - Plain text;
1 - (по умолчанию) HTML.

Поведение свойства:
- поддерживается если type установлено в "Email"
script text Тело сценария вебхука (JavaScript).

Поведение свойства:
- обязательно если type установлено в "Webhook"
timeout string Тайм-аут сценария вебхука.
Принимает секунды и единицу времени с суффиксом.

Возможные значения: 1-60s.

По умолчанию: 30s.

Поведение свойства:
- поддерживается если type установлено в "Webhook"
process_tags integer Обрабатывать значения свойств JSON в ответе сценария вебхука как теги. Эти теги добавляются к любым существующим тегам проблемы.

Возможные значения:
0 - (по умолчанию) Игнорировать ответ сценария вебхука;
1 - Обрабатывать ответ сценария вебхука как теги.

Поведение свойства:
- поддерживается если type установлено в "Webhook"
show_event_menu integer Добавлять пункт в меню событий, который ведет на пользовательский URL. Также добавляет свойство urls в результат problem.get и event.get.

Возможные значения:
0 - (по умолчанию) Не добавлять пункт меню событий или свойство urls;
1 - Добавлять пункт меню событий и свойство urls.

Поведение свойства:
- поддерживается если type установлено в "Webhook"
event_menu_url string URL, используемый в пункте меню событий и в свойстве urls, возвращаемом problem.get и event.get.

Поведение свойства:
- поддерживается если show_event_menu установлено в "Include event menu entry and urls property"
event_menu_name string Имя, используемое в пункте меню событий и в свойстве urls, возвращаемом problem.get и event.get.

Поведение свойства:
- поддерживается если show_event_menu установлено в "Include event menu entry and urls property"
parameters array Параметры Webhook или script.

Поведение свойства:
- поддерживается если type установлено в "Webhook" или "Script"
description text Описание типа оповещения.

Параметры вебхука

Параметры вебхука имеют следующие свойства.

Свойство Тип Описание
name string Имя параметра.

Поведение свойства:
- обязательно
value string Значение параметра, поддерживает макросы.
Поддерживаемые макросы описаны на странице Поддерживаемые макросы.

Параметры скрипта

Параметры скрипта имеют следующие свойства.

Свойство Type Описание
sortorder integer Порядок, в котором значения параметров будут передаваться скрипту как аргументы командной строки, начиная с 0 для первого аргумента.

Поведение свойства:
- обязательно
value string Значение параметра, поддерживает макросы.
Поддерживаемые макросы описаны на странице Поддерживаемые макросы.

Шаблон сообщения

Объект шаблона сообщения определяет шаблон, который будет использоваться как сообщение по умолчанию для операций действия при отправке уведомления. Он имеет следующие свойства.

Свойство Type Описание
eventsource integer Источник события.

Возможные значения:
0 - Триггеры;
1 - Обнаружение;
2 - Авторегистрация;
3 - Внутренние события;
4 - Сервисы.

Поведение свойства:
- обязательно
recovery integer Режим операции.

Возможные значения:
0 - Операции;
1 - Операции восстановления;
2 - Операции обновления.

Поведение свойства:
- обязательно
subject string Тема сообщения.
message string Текст сообщения.